Artifacts > Environment Artifact Set > {More Environment Artifacts} > Manual Styleguide
Artifact:
|
Manual Styleguide |
Describes how the end-user support manuals should be developed. |
Role: | Technical Writer |
Enclosed in: | Software Development Plan |
Input to Activities: | Output from Activities: |
The purpose of the Manual Styleguide is to describe the stylistic conventions to be used to develop end-user support materials. A Manual Styleguide gives advice on, and rules for, spelling general and domain-specific terms, sentence style, and technical writing issues.
Manual Styleguides are developed during the Elaboration phase.
A Manual Styleguide is needed if there is a significant amount of user documentation, including both printed and on-line documentation.
Use existing styleguides, such as [HAC97]
and [MOS98], as there are few good books
available on this topic.
Rational Unified Process |