Technical Documentation and Process

3

Developing a Style Guide

3.1 Introduction

A style guide is intended to assist the authors and editors of technical documents, reducing collaboration time by eliminating the need to combine differing formats into a single document. The guidelines given, typically along with a template, are intended to make the process of generating documents easier for all of those involved in the effort. Not all guidelines are appropriate for all situations; however, for the sake of consistency across all technical documents within an organization, the style guide should be followed to the extent possible.

3.1.1 Definition of Documents

The first step in developing a style guide is to identify the range of documents that the guide is intended to address. ...