| Technical writing is a specialized field
| |
| | who represents thereading audience.
|
| which not only demandsan in depth
| |
| | - Add a glossary if necessary for your
|
| knowledge of the subject on which you are
| |
| | technical terms. Orplace short
|
| writing,but also a good command of the
| |
| | explanations of the terms in brackets
|
| written language. A common maingoal is to
| |
| | within thepiece.
|
| translate tec-speak into everyday
| |
| | - When possible, incorporate examples and
|
| familiar jargon forthe average reader. In
| |
| | illustrations toget your points across.
|
| other words, your content needs to
| |
| | - If your data is complicated use graphs,
|
| beunderstood.
| |
| | diagrams and / or flowcharts to make it
|
| To help keep technical translation plain
| |
| | visually expressive.
|
| and simple, here aresome tips:
| |
| | - Experiment with different software to
|
| - Plan ahead. Determine the main focus,
| |
| | enhance yourpresentations. For example,
|
| i.e. what the readersneed to learn from
| |
| | add audio / video.
|
| your content. Ask yourself, what are
| |
| | There are excellent technical writing
|
| theirexpectations from the article?
| |
| | books out there. Checkwith your local
|
| - Take care to match your content to the
| |
| | public library for some and on
|
| level of knowledge ofthe audience. Dont
| |
| | Andbroaden the scope of your projects
|
| underestimate your audience and write
| |
| | with good technical writingskills.
|
| downto them. But do watch the level of
| |
| | You can also head to Content Propulsion
|
| your tec-speak.
| |
| | Lab.
|
| - Ask someone to proof read your material
| |
| |
|
