|
A publication that features ideas for writing step-by-step procedures and troubleshooting support documentation for electronic, Internet, and print distribution--and much more! Abbreviations and AcronymsAbbreviations are the shortened form of a word or phrase; such as U.S. for United States, sec. for secretary, adj. for adjective, C.P. for Command Post, and so on. Most professions and all governmental entities have their own lists of "approved" abbreviations for use when space is limited as in notes, tables and lists. The assumption is that everyone reading a document with abbreviations knows their meaning. Abbreviations usually exclude vowels after the first or second letter and include a letter or two to represent each syllable in the word. But there are many exceptions; for example, abbreviation (ab-bre-vi-a-tion) is usually shortened to: abbrev. To identify them as abbreviations, most writers will insert a period after the abbreviation of a word and after each letter that represents words in a phrase. But again, there are many exceptions; for example, the United States can be abbreviated as U.S or US. A capitalized letter is often used to represent each word in a phrase, the only exceptions being the articles: and, of, on, the. For example, the radio broadcast station Voice of America's name is abbreviated as either V.O.A. or VOA. It is in the abbreviation of phrases that abbreviations resemble acronyms. It is always acceptable to mix full words and abbreviations in tables, lists and package labels. Just because you used an abbreviation for one word, there is no reason to use it again if there is sufficient space for the full word elsewhere. Abbreviations must be consistent in the same document, never use a different spelling for an abbreviation in the same document. Originally intended to facilitate the shorthand transcription of conversations onto paper, when an abbreviation becomes commonly used in conversations, it may be considered as an acronym. (Consider: Internet abbreviations and capitalizing abbreviations.) Acronyms are words formed from the first or first few letters in a series of words; for example, codec was derived from compression/decompression and radar from radio detecting and ranging. Although most acronyms are capitalized, periods are not used to separate letters representing individual words; use DOS for Disk Operating System, not D.O.S. (Consider: capitalizing Acronyms .)
"Abbreviations and Acronyms" and other concepts are thoroughly explored in the book: Technical Writing with Style.  Abbreviations and Acronyms with NumbersWhen abbreviations and numbers are used together, most authors do not insert a space between them because together they are an adjective used to describe a product.
Measurement reference scale
Units of Measure abbreviations
Mathematical operators
Examples:
Comments: The word "bits" is represented by a lowercase "b." The word "bytes" is represented by a uppercase "B." Consider: capitalizing Abbreviations and Acronyms .) "Abbreviations and Acronyms with Numbers" and other concepts are thoroughly explored in the book: Technical Writing with Style. Using an Acronym Without DefinitionTypically, when acronyms are printed, either the acronym or the words it represents are placed in parenthesis. The definition of an acronym need not be included: a. For relatively old concepts with definitions that are generally known ("i.e."); b. When spoken, the acronym sounds like no other word; and c. When the reader is assumed to have some familiarity with the topic which should include the acronym. Examples:
"Using Acronyms Without Definition" and other concepts are thoroughly explored in the book: Technical Writing with Style. Evolving AcronymsVariations of Acronyms should start with the core technology followed by a hyphen and then subset concept. This will differentiate the device or process from those it may have derived from; as well as, those that derived from it. Examples:
Comments: DHTML is an incorrect construction of a new word for "Dynamic HTML." When constructing variations for acronyms, the abbreviation should start with the core technology acronym, followed by a hyphen and then subset concept. HTML-D is an acceptable construction. In a glossary or dictionary, it would follow HTML. Why should a reader have to page between the "H" section of a dictionary and the "D" section. Imagine yourself writing a glossary and you need to include references to various compact disk devices. Would it not be better to find these words listed together?:
Yes I know "Dynamic HTML" reads well, but the Internet is international; many of its users speak English as a second language and often it is the "British English" dialect. For people whose primary language is other than English, "HTML Dynamic" may be easier to understand. Glossaries and dictionaries are self-educational tools. If you are typical, when you lookup a specific word, you will also read definitions of one or more other words printed on the same or opposite page. These suggestions can help you to differentiate the device or process from those it may have derived from; as well as, those that derived from it. "Evolving Acronyms" and other concepts are thoroughly explored in the book: Technical Writing with Style.
Internet abbreviationsThese abbreviations are primarily intended for email communications. The assumption is that those who see read them will understand their meaning rather than interpreting the abbreviations as spelling or typographical errors. Examples of abbreviated phrases:
Email communications has developed its own set of common abbreviations. Common facial expressions; also known as emoticons and "smileys," are substitutes for face-to-face communications that are used in email communications. The use of smileys assumes that readers will understand their meaning. Examples: :-) for smile :-\ for undecided ;-) for wink :- for tongue tied :-} for grin :-@ for screaming :-( for frown :-o for surprised :-| for indifferent :-D for laughing for devilish for mad :'-( for crying :-* for kiss {} for hug "Internet Abbreviations" and other concepts are thoroughly explored in the book: Technical Writing with Style. Compound Abbreviations in Tables and ListsSpace constraints, as often occurs in tables and lists of detailed technical information, may require the use of more than one acronym or abbreviation to describe a single product or process. Because they are printed and cannot be spoken without translation, they are considered compound abbreviations. For Compound Abbreviations, hyphenate only the first one and then only if the hyphen connects it to a word (or acronym) naming the product or process. Subsequent adjectives (descriptions) are separated by commas. To fit more abbreviations into the table or list, it is acceptable to remove spaces between the comma and the abbreviation that follows it. No "and" is required. Within the table or list, the Compound Abbreviation should be read as if it is a single-sentence paragraph. The assumption is that the reader will be able to interpret the letter combinations and thereby understand what you are trying to communicate. Definitions for the individual letter combinations should always be included on the same or opposite page, along with any footnote definitions of asterisk, superscript or subscript references. Compound Abbreviations may also be used in product packaging. For this application, always consider the reader. A blizzard of letters and numbers can be confusing even to a salesperson. Whenever space permits, use the full word rather than its abbreviation. Examples:
Bullets ( ) require a little more space than commas and are excellent substitutes. When set in a color to complement the text, they can be quite attractive. Consider using other dingbat-like characters ( A, , h, e, E, ) to complement the theme of the table or list, provided they are small, unobtrusive and dissimilar to standard keyboard characters and symbols.
Use slashes rather than commas to divide statements where there is sufficient space before and after them. Without the additional space, slashes make reading the abbreviated statement more difficult because of their size, proximity to the other characters, and because readers may interpret them as abbreviational symbols for the words: by, times, with, part, and so on. "Compound Abbreviations in Tables and Lists" and other concepts are thoroughly explored in the book: Technical Writing with Style. Pronouncing Abbreviations and AcronymsFor abbreviations, pronounce the full word or words. For acronyms, either spell the word or state its derivation. Avoid using substitute words in speech that do not include the acronym in their implied spelling. Examples of Acronyms in speech:
Comments: I know people who are afraid of computers, even though they use them every day for limited repetitive tasks, like billing, writing letters, or updating mailing lists. The words we learn and use each day and the concepts they represent may be the source of much of their fear. They may simply express their fear as: "give me a computer where I don't have to type anything; that all I have to do is tell the computer what I want to do, and it will do it." "Pronouncing Abbreviations and Acronyms" and other concepts are thoroughly explored in the book: Technical Writing with Style.
Technical Writing with Style - SECOND EDITION - For 2000 |
