Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
overridefalse


Category
Short DescriptionProject Rules are defined by the team to enhance the collaboration and to define project standards.
Doctypedoctypehide
NameProject Rule
IDproject-rule
SuiteTeamwork
SetTeamworkhide
Parent
Parent Property
parent-doctypetopic
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience

Documentation Type
Name List
doctypedoctype-type
render-no-hits-as-blanktrue
namesQ1 - Process
propertyDocumentation Type

Tags
Tag List
namesTeamwork

Iteration

Iteration
value

facade

production

hide
DefineSort Keyhide



Section
indextrue
titleDescription

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.


Section
titleProperties


Transclusion
documentNote Box referencing common Document Properties
idsBox


Section
titleType

Specify the type of the project rule to organize them.

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



Section
titleSections


Section
titleDescription

Describe the purpose of the project rule.


Section
titleJustification

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.


Section
titleAdvantages

List the advantages gained on using this rule.


Section
titleDisadvantages

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


Section
titleRecommendations

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.


Section
titleTest

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



Section
titleDetails


Section
indextrue
titleRelated Doctypes

...