Operations Documentation

Definition

Operations documentation is the operations task during which operations documentation is produced.

Objectives

The typical objectives of the operations documentation task are to:

• Ensure that the operations manual is complete, consistent, correct, unambiguous, and understandable.

Preconditions

The operations documentation task can typically begin when the following preconditions hold:

• The usage phase has begun.
• The operations team has been adequately staffed, trained, and experienced in operations documentation.

Completion Criteria

The operations documentation task is typically complete when the following postconditions hold:

• The operations manual has been completed, passed inspection, and been accepted by the customer representative.

Steps

The operations documentation task typically involves the following teams performing the following steps in an interative, incremental, parallel, and time-boxed manner:

• Operations Team:
  • TBD

Techniques

The operations documentation task can typically be performed using the following techniques:

• Documentation content and format standards
• Documentation templates

Work Products

The operations documentation task typically results in the production of all or part of the following work products:

• Operations Work Products:
  • Operations Manual

Guidelines

• TBD