BASICS OF TECHNICAL WRITING

What Is Technical Writing?

Technical writing is defined by its subject matter: It is writing that deals with topics of a technical nature. By technical we mean anything having to do with the specialized areas of science and technology.

Technical vs. nontechnical writing

Because technical writing usually deals with an object, process, system, or abstract idea, the language is utilitarian, stressing accuracy rather than style. The tone is objective; the technical content, not the writing style or author's feelings toward the subject, is the focal point.
The difference between technical writing and ordinary composition is more than just content, however. The two differ in purpose as well. The primary goal of any technical communication is to transmit technical information accurately. In this regard, technical writing differs from popular nonfiction, in which the writing is meant to entertain, or from advertising copywriting, which is intended to sell.
Technical writers are concerned with communication. If they have to, they will sacrifice style, grace, and technique for clarity, precision, and organization.

Good Technical Writing Is ...

1. Technically Accurate
2. Useful
3. Concise
4. Complete
5. Clear
6. Consistent
7. Correct in Spelling, Punctuation, and Grammar
8. Targeted
9. Well Organized
10. Interesting




2 A Few Useful Rules of Writing Numbers, Units of Measure, Punctuation, Abbreviation, and Capitalization

Numbers

1. Write out all numbers below 10
2. When two or more numbers are presented in the same section of writing, write them as numerals
3. Write large numbers in the form most familiar to your audience and easiest to understand.
4. Place a hyphen between a number and unit of measure when they modify a noun.
5. Use the singular when fractions and decimals of one or less are used as adjectives.
6. Write decimals and fractions as numerals, not words.
7. Do not inflate the degree of accuracy by writing decimals with too many digits.
8. If a number is an approximation, write it out.
9. Do not begin a sentence with numerals.


Units of Measure

10. Keep all units of measure consistent.
11. Write secondary units in parentheses after the primary units.

Punctuation

12. Hyphenate two adjacent nouns if they are both necessary to express a single idea.
13. In a series of three or more terms with a single conjunction, use a comma after each except the last.
14. Omit the period at the end of a parenthetical expression within a sentence; retain it if the entire parenthetical expression stands alone as a sentence.

Abbreviation

15. Spell out abbreviations at their first appearance.
16. Omit internal and terminal punctuation in abbreviations.
17. The abbreviation for a specific word or phrase takes the same case (upper case or lower case) as the word or phrase.



Capitalization

18. Capitalize trade names.
19. Do not capitalize words to emphasize their importance.
20. Capitalize the full names of government agencies, companies, departments, divisions, and organizations.