projectdoc Toolbox

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

ID
project-rule
Suite
Parent
Documentation Type
Tags
Teamwork

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.

Notes

These are internal notes that are usually not exported and only visible to team members with write access.

But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.

 

The text of notes sections is also indexed.

References

For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.

 

For further information please refer to References and Resources.

Resources

The resources section provides references to further information to the topic of the document.

This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.

 

For further information please refer to References and Resources.