Versions Compared

Key

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

...

Section
titlePrinciples

Principles are abstract rules to gain desirable results.

Note Box
titleWhat works for us

Principles need to support a desired quality and be

  1. clearly worded
  2. consistent
  3. no further reducible

We provide references to further resources, helping readers to form their own informed view on this topic. But in the end the borders between values, principles, and practices are based on opinions and experiences and therefore blurry. Readers will come to different conclusions and categorizations.

In the end what matters is simply not the answer to the question "Couldn't is been done differently?" (yes, it can!), but "If we do it that other way, wouldn't it have more positive impact on what we do?".

The lists of principles and practices are meant as a source of inspiration to be adopted and applied to the reader's own way of working. It is not a dogmatic set of rules.

This is by definition a work in progress. If you have a contribution to make, please get in touch!


Hide From Reader

Create from template
blueprintModuleCompleteKeyde.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-teamworkcore:projectdoc-teamwork-blueprint-doctype-patterntopic
contentBlueprintIde896013dd5c25c98-4965a8da-4a634cb1-ba9ba041-bbc2d6eb8baa4cef386268fb
templateNamee896013dd5c25c98-4965a8da-4a634cb1-ba9b-bbc2d6eb8baaa041-4cef386268fb
createResultedit
buttonLabelNew Principle

The following principles help to create desirable qualities or values in documentation. So these principles establish and maintain an effective and efficient communication with the stakeholders of a project.

Tip Box
titleActionable Practices

In order to make principles more actionable, teams develop practices.

The following lists group principles by their domain in which they are typically applied. Since our background is software development, you'll find some basic principles associated with this domain, which would also easily be applied to other domains.

Section
titleDocumentation Principles
intro-textThe following principles are pure documentation principles and have no relative in software design or in the agile or lean mindset.

Display Table
doctypepattern
render-modetable=projectdoc-alternating[columns=220px,*,220px]
selectName, Short Description, Values
restrict-to-immediate-childrentrue
whereDoctype=pattern $<Domain>=[Documentation]
header-translationsValues=Supported Values


Section
titleDesign Principles
intro-textThe following principles of software design also apply to documentation.

Display Table
doctypepattern
render-modetable=projectdoc-alternating[columns=220px,*,220px]
selectName, Short Description, Values
restrict-to-immediate-childrentrue
whereDoctype=pattern $<Domain>=[Software Design]
header-translationsValues=Supported Values


Section
titleAgile/Lean Principles
intro-textThe following agile and lean principles also apply to documentation.

Display Table
doctypepattern
render-modetable=projectdoc-alternating[columns=220px,*,220px]
selectName, Short Description, Values
restrict-to-immediate-childrentrue
whereDoctype=pattern $<Domain>=[Agility]
header-translationsValues=Supported Values


...