Design Documentation
Design documentation is the
design
task during which the designs are
documented in the various design documents.
The typical objectives of the design documentation task are
to:
- Communicate the design to its stakeholders, especially
those who must implement and test it.
Design documentation can typically begin when the following
preconditions hold:
- Appropriate tailored content and format standards exist
for the design documentation.
- Appropriate tailored templates exist for the design
documentation.
- The
database
team,
software development team, and
user experience team are staffed and trained in design
documentation.
- The design reuse and/or design production tasks have
begun.
Design documentation is typically complete when the
following postconditions hold:
- The following design documents have been completed and
passed inspection:
Design documentation typically involves the appropriate
design teams performing the following steps in an iterative,
incremental, and parallel manner:
- Read the content and format standard for the
document.
- Instantiate the template for the document.
- Fill in the document using the:
- Design models and design decisions made during the
design production task.
- Reusable design documentation identified, selected, and
tailored during the design reuse task.
Design documentation can typically be performed using the
following techniques:
- Content and format standards
- Templates
Design documentation typically results in the production of
the following work products in an iterative, incremental,
parallel, and time-boxed manner: