There should either be no need for additional documentation for an artifact or that documentation should be as close as possible to the artifact. This make it more probable that the documentation changes with the artifact and therefore keeps up-to-date.

Related Practices

The following practices are related to this principle.

Describe Content: To make it easier for readers to determine the relevance of a document, there should be short description for each document.
Single Sourcing: Reduce redundancy by having one source of truth for each information. This way the written information is more easily reusable in other documents and - which is even more important - it is referenceable. Single sourcing demands automation.

Related Principles

The following principles are related to this principle.

DRY Principle: Redundant information is hard to maintain, keeping it in-sync. Therefore strive for reducing redundancy by defining one authoritative location for each piece of information.
KISS Principle: Keep your documentation simple. Assume that authors have relevant information for the project in their mind, but not necessarily the skills and resources to communicate it. Therefore make it very simply and joyful for them to share their expertise.
Law of Demeter: Documents should not reference details in other documents that may change without notice.
Open Closed Principle: Be open for extension, closed for modification.
Principle of least Astonishment: Documentation should appear to the reader as being written by one single person. Uniformity reduces the chance of astonishment. The principles applies to all areas of documentation, including style and organization.
Separation of Concerns: Reduce the amount of documents with overlapping information. Also divide the concerns regarding the formatting and - as far as possible - the structure from the content. Whenever there are different aspects, consider if handling them independently would make things easier.
Single Responsibility Principle: A document should focus to answer one question. This way documents can be more easily reused and combined.
Stable Dependencies Principle: A document should only reference documents that are not less stable than itself.
YAGNI Principle: Assume that an information is not needed to be written down unless proven otherwise.

Resources

More information related to this principle.

Self-documenting code: Information on self-documenting code on Wikipedia.

pattern

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Related Practices

Related Principles

Resources

About

Keep up-to-date!

Powered by