The following list of document preparation and production tasks provides a template for a typical APM project. Project managers must select the task set that is appropriate for a specific project.
IMPORTANT NOTE: Documentation preparation and production is conducted concurrently with other APM activities and tasks. In most cases, information developed as part of a software engineering task is used as 'input' for a documentation task.
U.5.1 Select the appropriate document outline for the software engineering information to be documented.
APM document outlines are presented in another section of this site.
U.5.2 Identify information created during software engineering (CPF) tasks and required for the appropriate document.
APM document outlines specify a variety of information that has likely been created as part of corresponding CPF tasks. The software engineer must identify this information and use the appropriate tools to transfer information to available desk-top publishing tools.
U.5.3 Develop additional document content.
Add additional connecting text and supplementary information as specified by the document outline.
U.5.4 Construct the document.
If reuse has been adopted as an organizational objective, the amount of 'new writing' may be kept to a minimum (and the time required for documentation may be minimized) by using reusable document fragments.
U.5.5 Review the completed document for correctness.
Conduct a formal technical review (or less formal review where appropriate) to assess the correctness of the document.
Use Browser "back" arrow or return to APM Process Design Language Description