| Full title | Elaborate on an approach for documenting processes and artifacts |
|---|
| Objective | Identify the artifacts, processes and decisions that need to be documented. Define a maintenance policy for the documentation. |
|---|
| Applicability | This practice spans across the entire project , but is particularly important in the initial phases of the project. |
|---|
| Context | The practice applies to all projects. |
|---|
| Addressed elements in SMM | 2.2. Documentation development and management |
|---|
| Actions | - Identify relevant artifacts, processes and decisions that need to be documented
- Identify public and restricted documentation
- Identify the items that need and do not need to be documented
- For each item that needs to be documented, indicate prospective recipients for the documentation
- Avoid over- and under-documenting.
- Define a policy (policies) for documenting
- Assign responsibility for maintaining the documentation and/or processes
- A documentation policy defines the content, format, recipients and the maintenance approach.
- Define maintenance policies for various items and periodically update them. Give priority to core items or items frequently changed
- Periodically verify if the policy is followed and adhered to.
- Provide a feedback channel for the public documentation
|
|---|
| Risks | - The documentation policy is not followed
- The documentation becomes obsolete and its users cannot rely on it
- The documentation policies are not properly assigned to items
- Relevant items may be inadequately documented
- The documentation policy is not updated
- The policy does not correspond to current needs.
|
|---|
| Related practices | |
|---|
