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

Compare with Current View Page History

« Previous Version 6 Next »

 

List of principles for agile documentation (mostly) derived from software development principles.

Principles

Principles are abstract rules to gain desirable results.

What 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!

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.

Actionable 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.

Documentation Principles

The following principles are pure documentation principles and have no relative in software design or in the agile or lean mindset.

The query matched no documents.

Design Principles

The following principles of software design also apply to documentation.

The query matched no documents.

Agile/Lean Principles

The following agile and lean principles also apply to documentation.

The query matched no documents.

Resources

More on documentation values and documentation practices:

Values
Values represent characteristics or qualities of documentation that are important to readers, writers, and sponsors.
Practices
Practices to collaborate on agile documentation.

  • No labels