Content and Format - s1029cn0028

DOE-STD-1029-92

CONTENT AND FORMAT

3.1

General Content and Format Guidelines

This section discusses the technical subject matter content and organization of a

procedure. It also defines the format of procedure pages, headers, and other elements.

All types of procedures are not within the scope of this writer's guide. While sections

within this writer's guide may apply to other than technical procedures, writers should

exercise discretion when applying the guidance presented. For help with procedures

exclusively formatted with graphics, or those portions of procedures which combine

graphics and text, the DOE Guide for Use of Graphics in Procedures will, when

completed, be attached as an appendix to this document.

3.1.1 Appropriate Level of Detail

Writing at the appropriate level of detail is the key to successful communication with

procedure users. For ease of use and to reduce distraction and confusion, only include

information in the procedure that relates directly to completing the task.

[1]

Write procedures to a level of detail consistent with the qualifications and training

of the expected users. Job task analyses and training records provide information

useful in assessing the level of detail requirements. When in doubt, write to the

lowest common denominator.

[2]

Provide a level of detail that takes into account the following variables:

C Qualification level of the user. As qualification level increases, level of detail

can decrease on tasks that are simple or are frequently performed.

C Complexity of the task. As task complexity increases, level of detail can

increase.

C Frequency of task performance. As task frequency increases, the level of detail

can decrease.

C Degree of standardization desired. Level of detail varies directly with the

degree of standardization desired. The more standardized the performance, the

more detailed the procedure.

[3]

Determine whether the amount and kind of information provided are adequate for

intended users by answering the following questions:

C Can the procedure be performed in the sequence it is written?

C Can the user locate and identify all equipment referred to in the procedure?