You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »

projectdoc Toolbox

Project Rules are defined by the team to enhance the collaboration and to define project standards.

ID
project-rule
Suite
Documentation Type
Tags

Description

Document a rule defined by the team to improve collaboration. Project rules also help to define project standards and conventions. Try to automate the checking process. This helps team members to fix rule violations quickly.

Properties

The document type project-rule provides the following properties:

 

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Type

Specify the type of the project rule to organize them.

Use the Project Rule Type to define types of project rules.

Sections

Description

Describe the purpose of the project rule.

Justification

Explain every rule so that each team member understands the reasons, why this rule is important. This also allows the team members to test, if the reasons are (still) valid and make suggestions for improvement.

Advantages

List the advantages gained on using this rule.

Disadvantages

Most rules come with a cost. List the disadvantages of following the rule here. Maybe they could be mitigated by adjusting the rule?

Recommendations

List the recommendations or best practices on how to apply this rule. Hopefully the test of having the rule applied successfully can be automated. List a reference to the tools to use here.

Test

Show how the successful application of the rule can be tested.

  • No labels