Patterns to support team collaboration.
Patterns of this Type
| Name | Short Description |
|---|
| Agile Documentation | A document is considered to follow the agile principle if it is valuable, essential, and created or updated just-in-time. A documentation is created and maintained in an agile way, if all its documents follow this practice. |
| Describe Content | To make it easier for readers to determine the relevance of a document, there should be short description for each document. |
| Document State | To set the expectation right it is useful to communicate the state of each document to the collaborating authors and the readers. |
| Employ a Style Guide | All publishing organizations define a style guide for their published information. Such a guide supports teams to write in a similar tone, making it easier for readers to digest the information. |
| Focus on Content | Make it easy for knowledge workers to focus on content and remove the need to define the document structure and formatting on a ad-hoc basis. |
| Maintain a Glossary | To enforce a common understanding of the domain, a glossary should define the terms important for the project. This also supports the ubiquitous language and makes sure nobody is left behind. |
| No Noise | Do not render text to the reader that has no information value. |
| Principle of Iteration | Documentation is often created in a process of constant change. Therefore project documentation is never complete. |
| Standard Layout | A standard layout makes it easier for new members of a team to find information. A standard layout is project independent and is typically defined by an organisation. |
| Use Templates | Define a basic structure for all artifacts of a given type. Readers will have an easier job on finding and learning about the information in your documentation. |
| Use your Tools | Experts need the freedom to employ the set of tools they work most effectively and efficiently. |
