projectdoc Toolbox

Patterns provide solutions for problems in a given context. Patterns are usefull in multiple areas such as design, architecture, documentation, or process.

ID: pattern
Suite: Teamwork
Parent: Doctypes for Teamwork
Documentation Type: Q1 - Process, Q2 - Project, Q3 - Product, Q4 - System
Tags: Teamwork

Document a solution the team wants to apply to problems in a given context. Patterns are useful in multiple areas such as design, architecture, documentation, and process.

Properties

The document type pattern provides the following properties:

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Type

Specify the type of the pattern to organize them.

Use the Pattern Type to define types of patterns.

Domain

Organize patterns by domains.

Sections

Description

Give a brief overview over the purpose and application of the pattern.

Example

Provide one or more examples that help readers to understand what the pattern is about. This is an introduction to the pattern.

Context

List and describe situations within which the pattern is applicable.

Problem

Describe the problem the application of this pattern solves.

Structure

Describe the structure of the pattern including a description of its participants.

Advantages

Describe the advantages of using the pattern.

Disadvantages

Describe the disadvantages of using the pattern.

Variants

Describe variants to the pattern.

Notes

These are internal notes that are usually not exported and only visible to team members with write access.

But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.

The text of notes sections is also indexed.

References

For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.

For further information please refer to References and Resources.

Resources

The resources section provides references to further information to the topic of the document.

This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.