A

abbreviations and acronyms

An abbreviation is the shortened form of a word or phrase used to represent the complete form. An acronym is a word formed either from the initial letters of a term (OOP for object-oriented programming) or from parts of words in a series (FLOPS for floating-point operations per second).

NOTE An abbreviation or acronym enclosed in parentheses follows the term unless the abbreviation or acronym is more commonly recognized, such as a.m. and p.m.

Consider whether the abbreviated form is pronounced or spelled when using the indefinite article a or an before it. For example, the acronym SQL is pronounced "sequel," not "S-Q-L." So "a SQL application" (not "an SQL application") is correct. Likewise, write "an MGraphic object" (not "a MGraphic object").

Using abbreviations

Use abbreviations:

Immediately after the first mention of a term or phrase within a chapter or section. Spell out the term or phrase and follow with the abbreviation in parentheses.
For all subsequent references to a term or phrase within a chapter or section.
If the abbreviation is more commonly recognized than the spelled-out form. For example, use a.m., not ante meridiem; use ASCII not American Standard Code for Information Exchange.
When you expect the target audience to know the meaning of the abbreviation, for example: CD-ROM, CPU, ANSI, or DOS.

Avoid abbreviations:

In section heads
In a sentence or paragraph with too many abbreviations
In illustration captions and table headings where users might be uncertain of the meaning
In tutorials designed for novices

Forming possessives of abbreviations

In general, use an adjective-noun relationship instead of the possessive form.

You can sometimes use an of construction (for example the requirements of ISO), but only if it doesn't sound stilted.

When you want to form a possessive, use an apostrophe s.

Forming plurals of abbreviations

When forming plurals of abbreviated forms:

Form the plural with a lowercase s (never an es).
If the abbreviation contains internal punctuation, form the plural with an apostrophe s.

Avoiding periods in abbreviated forms

In general, do not use periods in an abbreviation or acronym unless it can be confused with a word (such as in for inches).

See individual entries for commonly used abbreviations, acronyms, and technical terms.

For abbreviations of units of measurement and guidelines for using them, see the Appendix.

abort

Do not use this term. Instead, use end or terminate.

active voice

Use active voice rather than passive voice wherever possible in Taligent technical documentation.

Active voice has two benefits:

Active voice indicates clearly by its form who performs the action of the sentence.
Because this who so often is the reader, active voice speaks more directly to your audience.

A sentence such as

doesn't indicate who is to perform the action, and--if that performer is the reader--doesn't assign the reader an active role in the documentation.

Whether you use

depends upon whether you are providing procedures or a more general discussion, but each informs and actively involves the reader.

(Passive voice does have legitimate uses. For a discussion of those uses and the formation of passive construction, see "passive voice" on page 58.)

add on

add-on

(modifier, noun)

ad hoc

Exception to the rule of avoiding Latin terms.

affect

(verb) To influence. See also "effect" on page 21.

all-inclusive

allow

Implies permission or overcoming resistance. Instead, use help, provide, enable, accommodate, or make possible.

all right

Do not use alright.

alphanumeric

alternate

Implies turns are taken. Do not confuse with alternative.

alternative

Use when a choice of two or more options is implied.

a.m.

Use the abbreviation because it is more commonly recognized than ante meridiem. Note lowercase letters in the abbreviation.

and/or

Avoid using a slash. Use and or or, or rewrite. When appropriate, use: x, y, or both x and y.

ANSI

When the context is clear, use the acronym because it is more commonly recognized than American National Standards Institute. Note capitalization.

anti-aliased

antialias

apostrophe

Use the apostrophe to form possessives, contractions, and certain plurals.

Forming possessives

Placement of the apostrophe depends on the number and form of the noun:

Singular nouns not ending in s - Add an apostrophe first and then the s.
Singular nouns ending in s - Add an apostrophe after the final s in the noun.
Plural nouns not ending in s - Add apostrophe s.
Plural nouns ending in s - Add an apostrophe after the final s in the noun.

Some expressions, though more descriptive than possessive, also take the possessive form. Nouns modified by periods of time or sums of money are good examples. In these instances, form the possessive according to the guidelines described above.

Note that the possessive of it is its, not it's, which is the contraction of it is.

Forming contractions

Taligent style allows you to use contracted words where the rhythm and flow of a sentence would be disrupted by the noncontracted form. Place the apostrophe where the omitted letters or numbers would occur if the word or number were fully written out.

Forming certain plurals

When forming certain plurals, add apostrophe s. Apostrophes are used to form the plural of:

Abbreviations with internal punctuation

appendixes

Plural of appendix. Do not use appendices.

artificial intelligence (AI)

Spell out on first occurrence.

ASA

When the context is clear, use the abbreviation because it is more commonly recognized than American Standards Association. Note capitalization.

ASCII

When the context is clear, use the acronym because it is more commonly recognized than American Standard Code for Information Interchange. Note capitalization.

assembly language

assembly-language

assure

To declare earnestly. Do not confuse with "ensure" on page 23 or "insure" on page 34.

asynchronous (async)

Note spelling of abbreviation.

[Contents] [Previous] [Next]

Click the icon to mail questions or corrections about this material to Taligent personnel.

Copyright©1995 Taligent,Inc. All rights reserved.

Generated with WebMaker