Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionList of principles for agile documentation (mostly) derived from software development principles. 
Doctypetopichide
NamePrinciples 
Short Name 
Parent
Parent Property
propertyParent
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 
Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
 
Expected Duration 
Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 
Iteration

Iteration
valuefinished

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesReference
propertyType

hide
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors
 

Sort Key0010-0020hide
Section
titleDescription

...

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
  4. plausible
  5. broadly acknowledged

We mainly address the first three requirements and continuously improve on them. We intend our descriptions and explanations for principles (and practices) to be plausible, but we certainly cannot (and do not intend to) control their broad acknowledgement. For the latter we provide references to further resources, helping readers to make up their own informed opinion. 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-teamwork:projectdoc-teamwork-blueprint-doctype-pattern
contentBlueprintIde896013d-4965-4a63-ba9b-bbc2d6eb8baa
templateNamee896013d-4965-4a63-ba9b-bbc2d6eb8baa
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

...

Section
titleResources

More on documentation values and documentation practices:

Tour
render-as-definition-listtrue
replace-title-with-nametrue
TitleShort Description
Values 
Practices 
Piwik Set Multiple Custom Variables
NameValue
Departmentagiledoc
Categoryindex
Typeprinciples