HP TextEngineer Technical Writing Guide Instrukcja Użytkownika Pobierz pdf (Strona 7)

Company Writer's Guide

[For Illustration Only] 1-7

Capitalize all letters in each of the following:

• Main section headings

• Acronyms, initialisms

Do not capitalize:

• Generic product and component names (for example, controller, panel, switch)

• Generic system names

• Acronym definitions (unless they belong in the above initial-cap group)

Capitalize the first letter of Government, Division, Plant, Project, etc., when referring to a specific

one. Use lower case when it is only a general reference.

1.5 NUMERALS AND UNITS

Both Arabic and Roman numerals may be used in company documents. General guidelines for

proper use are the following:

• Express safety class and quality group in Arabic numerals (1, 2, 3).

• Express seismic category in Roman numerals (I, II, III).

• Express electrical Class 1E in Arabic (not

IE).

• Express steps in a process in Arabic.

Use Arabic numerals unless specific nomenclature dictates otherwise (and with lower-case Roman

numerals for table of contents, list of figures, etc.).

Avoid spelling out large numbers unless nomenclature dictates it. Spell out integers less than 10

that do not apply to a specific measurement (e.g., two procedures, 2 inches). Use commas in four-

digit or larger numbers (except in hexadecimal numbers).

Be consistent in using units of measure. European customers require metric units of measure.

Preferred presentation of measurements in European projects is: metric or SI (followed by English

in parentheses).

Normally, in text, use written-out units. Exception: electrical units – V, A, Hz. Abbreviate other

units in tables and where space is limited.

1 2 3 4 5 6 7 8 9 10 11 12 ... 31 32

Brak uwag

HP TextEngineer Technical Writing Guide Instrukcja Użytkownika Strona 7