Technical Writing is not difficult when you know where and how to start. So, when you write a technical document, consider the following 7 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.
Related posts:
- How to Start a Career in Technical Writing Ivan Walsh gives some advise on how start a career...
- Writing User Guides Some points to consider when choosing software for writing...
- Checklist for Business Letters Checklist for Business Letters Be sympathetic to the reader’s...
- Word Tip – How to create Screentips that enhance your documents ScreenTips are those little boxes that appear when you ‘hover’...
- How to Write a Report? To succeed as a report writer, you need to...
