Documentation Standard Section 3

Back to higher level Paragraph 3.1.3

Section 3.1.3.3 Abbreviations and acronyms.

This page defines details for the rules for abbreviations and acronyms.

• 3.1.3.3.1 Clarity.
• Abbreviations and acronyms shall be used only when their meanings are unquestionably clear to the intended audience. WHEN IN DOUBT, SPELL IT OUT shall be the maxim.
• 3.1.3.3.2 Word-combination.
• Portions of abbreviations or acronyms for a word combination shall not be separated for use singly
• 3.1.3.3.3 Syntax.
• Unless otherwise indicated, the same abbreviations shall be used for all tenses, the possessive case, participle endings the singular or plural, and the noun and modifying forms of a term.
• 3.1.3.3.4 Capitalization.
• As a general rule acronyms are always used in the upper-case form. Abbreviations should be produced in lower-case form for documents but may be capitalized when required for emphasis.
• 3.1.3.3.5 Symbols.
• The distinction between abbreviations and symbols is difficult because it depends upon context rather than form. For example, "the current is 5 amps" and "the pressure is 3 atm" are allowable uses of abbreviations, whereas writing "I = 5 amp" and "p = 3 atm" are incorrect. Whenever a mathematical operation or sign is involved, such as the equality sign (=) or the division (/), abbreviations cannot be used.
  Mathematical operations are performed only upon symbols that appear in the ISO International System of Units are preferred, for example, "the current is 5A" in lieu of abbreviations.
• 3.1.3.3.6 Punctuation.
• An abbreviation spelling a whole word should include a full-stop if the abbreviation is not obvious to its intended reader. An exception is made for abbreviations used in computer applications wherein a hyphen (-) or underscore ( _ ) may be substituted for a blank space which appears in an abbreviation, e.g., "seq-chk" in lieu of "seq chk". Hyphens should be used with adjectival forms of abbreviations, acronyms and symbols e.g., a 35-mm film.
• 3.1.3.3.7 Abbreviations used in existing documents.
• Unless otherwise specified, any changes or revisions to drawings, specification, standard or technical document prepared under an earlier standard, may use the latest abbreviation, although the superseded abbreviations may appear elsewhere in the document.

Back to Home page MANAGING STANDARDS Home page

Please send any beneficial comments or identification of errors using the following form to: kenr@wysywig.airtime.co.uk