Process
Areas
(staged)

Level 2
 
REQM
 PP
 PMC
 SAM
 MA
 PPQA
 CM
Level 3
 
RD
 TS
 PI
 VER 
 VAL 
 OPF
 OPD
 OT
 IPM
 RSKM
 DAR
Level 4
 
OPP
 QPM
Level 5 
 
OPM 
 CAR

      5. Process Areas
          5.20. Technical Solution
              SG 3 Implement the Product Design
 SP 3.2 Develop Product Support Documentation 
Process AreaTS
Level3
GoalSG 3
PracticeSP 3.2

Develop and maintain the end-use documentation.

This specific practice develops and maintains the documentation that will be used to install, operate, and maintain the product.

Example Work Products

1.    End-user training materials

2.    User's manual

3.    Operator's manual

4.    Maintenance manual

5.    Online help

Subpractices

1.    Review the requirements, design, product, and test results to ensure that issues affecting the installation, operation, and maintenance documentation are identified and resolved.

2.    Use effective methods to develop the installation, operation, and maintenance documentation.

3.    Adhere to the applicable documentation standards.

Examples of documentation standards include the following:

·       Compatibility with designated word processors

·       Acceptable fonts

·       Numbering of pages, sections, and paragraphs

·       Consistency with a designated style manual

·       Use of abbreviations

·       Security classification markings

·       Internationalization requirements

 

4.    Develop preliminary versions of the installation, operation, and maintenance documentation in early phases of the project lifecycle for review by the relevant stakeholders.

5.    Conduct peer reviews of the installation, operation, and maintenance documentation.

Refer to the Verification process area for more information about performing peer reviews.

6.    Revise the installation, operation, and maintenance documentation as necessary.

Examples of when documentation may need to be revised include when the following events occur:

·       Requirements changes are made

·       Design changes are made

·       Product changes are made

·       Documentation errors are identified

·       Workaround fixes are identified


 




Process
Areas
(continuous)


Process
management  
 
OPF
 OPD
 OT  
 
OPP  
 OPM

Project
management
 
PP
 PMC 
 REQM 
 
SAM  
 
IPM
 RSKM
 
QPM

Engineering
 
RD 
 TS
 PI
 VER 
 VAL
Support
 
CM
 PPQA
 MA
 
DAR
 CAR