Work Product (Artifact): Manual Styleguide
This artifact describes how the end-user support manuals should be developed.
Purpose

The purpose of the Manual Styleguide is to describe the stylistic conventions to be used to develop user support materials. A Manual Styleguide gives advice on, and rules for, spelling general and domain-specific terms, sentence style, and technical writing issues.

Relationships
RolesResponsible: Modified By:
Input ToMandatory:
  • None
Optional: External:
  • None
Properties
Optional
PlannedYes
Tailoring
Representation Options

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.