7 Steps to Clear Technical Writing November 23, 2006
Posted by iawalsh in : How do I ?, Writing, Style, Templates, Recommended, Tips , trackback
When you write a technical document, consider the following points:
-
Glossary – make a glossary, even for a half dozen words.
-
Definitions – create a list of definitions and acronyms. Always explain what the acronym means when it’s first encountered.
Use bold for the definition or acronym to make it easy to find it again. -
Analogy - provide a comparison or analogy.
-
Graphics - Provide graphics to illustrate the object in question, how it is assembled, or how it is used by operatives.
-
Replace general, abstract, and needlessly objective words with more concrete, specific, and simpler words.
-
Break long sentences into shorter sentences.
-
Use terminology consistently.
These points are not meant to be all-inclusive. However, if you are new to tech writing, this should put you on the right road.
Comments»
no comments yet - be the first?