Artifacts > Environment Artifact Set > Manual Styleguide


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:

Purpose To top of page

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 of general and domain-specific terms, sentence style, and technical writing issue.

Timing To top of page

Manual Styleguides are developed during the Elaboration Phase.

Tailoring To top of page

A Manual Styleguide is needed if there is a significant element of user documentation, including both printed and on-line documentation.

Additional Information To top of page

Try to use existing styleguides, since there are several good books available. Examples of manual styleguides are [HAC97] and [MOS98].

Copyright  © 1987 - 2001 Rational Software Corporation

Display Rational Unified Process using frames

Rational Unified Process