To be used by TS staff
revised 11/9/99 -- email the TS Online Manual Team with questions or
comments
Style Guide for the Technical Services Online Manual
GENERAL GUIDELINES
Name the document. Be succinct and specific: "Using Antpac Order
Record Codes" is more useful than "Antpac Codes".
Explain the purpose of the document.
Identify the intended audience for the document.
Include your name and the date the document was composed.
GUIDELINES FOR PROCEDURES
Start at the beginning of a process or procedure and continue
through to the conclusion.
Break lengthy procedures up into separate sections and identify
each section by a capital letter and a specific title. Add a table of
contents at the beginning, with links to each section.
Number sequential steps.
Use an unnumbered list for choices, example, checklists, etc.
Use the active, not passive, voice:
Active voice: Prepare the vertical call number for the
cassette container.
Passive voice: The vertical call number is prepared for the
cassette container
Use the imperative form to give instructions; start with an action
verb such as those used in this guide.
Give examples.
FORMATTING GUIDELINES
Use a box for notes and warnings. Open with the word NOTE or
WARNING in capital letters.
Use a box for replicas of ANTPAC records.
Use bold for direct quotes from ANTPAC, and for other material
being emphasized within the text.
Use blue font sparingly, to draw attention to truly crucial
information in boxed text, such as warnings. Do not use it merely for
notes or background information. When using blue font, be sure that the
text is also emphasized in some other way (e.g. the word WARNING in
caps), since the color will not show up on a laser printout.
Use all capital letters and font size 4 for section titles within
procedures and other documents.