| Good tech writers use different techniques to explain what you need to know. Here
are three of the best tips for good writing.
1. Develop a document plan
Novice technical writers start writing straight away. They don't consider:
- What that reader needs to know
Experienced writers will first consider what's required - and then start
writing!
Before they write, they will set-up meetings with the users and gather as much data as
they can about their business/technical requirements.
It might seem slower, but it delivers much better results.
They will generally write a documentation plan, which includes milestones and deadlines
for the key deliverables.
2. Make it readable
Good technical writers make the work they produce easy to read and navigate.
They understand the user's frustration when trying to locate that
piece of information; they might use writing aids such as notes, abstracts and bullet
lists to improve the document's usability.
3. Edit Edit Edit
Technical writing is not prose or poetry. It is also not minimalist.
You need to engage the reader, so use a crisp, friendly style that explains
things clearly. Delete any superfluous text.
Focus on the task-at-hand.
Your Thoughts?
What are your thoughts on this? Drop me a line at ivan
at klariti dot com |
