Develop Product Support Documentation
This specific practice develops and maintains the documentation that
will be used to install, operate, and maintain the product.
- Review the requirements, design, product, and test results to
ensure that issues affecting the installation, operation, and
maintenance documentation are identified and resolved.
- Use effective methods to develop the installation, operation, and
maintenance documentation.
- Adhere to the applicable documentation standards. Examples of documentation standards include:
- 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
- Develop preliminary versions of the installation, operation, and
maintenance documentation in early phases of the project life cycle
for review by the relevant stakeholders.
- Conduct peer reviews of the installation, operation, and
maintenance documentation.
- Revise the installation, operation, and maintenance documentation
as necessary. Examples of when documentation may need to be revised include:
- Requirements change
- Design changes are made
- Product changes are made
- Documentation errors are identified
- Workaround fixes are identified