HP TextEngineer Technical Writing Guide manual Graphics, Editing Conventions

Company Writer's Guide

5.The ordering of documents in the reference list should correspond to the sequence of references used in the document, so that Reference 1 is the first one used, 2 the second, and so on.

6.Reference callouts may be of two types.

“This methodology is explained thoroughly in Reference 7…”

OR

“As was concluded in the Recorder Review (Ref. 2),…”

1.7GRAPHICS

Figures, tables, photos, and charts are all considered graphics. Figures, photos, and charts will be assigned figure numbers. Tables will be assigned table numbers. When using graphics, observe the following:

•Cite all graphics in text, with corresponding numbers.

•Number in sequence by second-level section — Figure 1.1-1 is the first figure cited in Section 1.1; Table 1.1-1 is the first table cited in Section 1.1, etc. If a graphic is cited in the text of a top-level section, the numbering is 1-1, 1-2, etc.

•Capitalize the initial letter of the words “figure” and “table” when they appear with a number; otherwise, use lower case (the figure shows the difference between . . .).

1.8EDITING CONVENTIONS

Many words and phrases can be written more than one way. Every project should use the broad list of writing conventions (preferred terms, spellings, punctuation) in this section, and define additional conventions as needed, to promote consistency among documents.

In the list, when a phrase is to be hyphenated in adjectival use as a unit modifier (um), that note accompanies the phrase. Other abbreviations in the list include (n) for noun and (v) for verb.

While this may be useful for reference, engineering authors should not spend precious time worrying about these details.

[For Illustration Only] 1-10