Admittedly, writing a manual will never be confused with creating great literature. After all, a manual is all about details and processes, not plots and characters. However, good writing is good writing no matter what the subject and it is up to writers to enhance the clarity and readability of even the most narrow technical topics.
That said, if you are having difficulties with getting your manual-writing project on-track, review the postings on "Writing & Editing" and "Technical Writing". Also, check out the appropriate links listed in the "Links" Section of this site to help you get started.
In the previous postings on this topic, it was stressed that putting together an effective manual is a formidable job for any writer. But as with most Business Writing Projects, we are talking about "Process". And although a Business Communicator may not necessarily author an entire manual, he or she will often be responsible for managing the writing process.
In real terms, this means coordinating and monitoring the following steps of the manual writing project:
* Determining Style and Format
* Identifying Resources
* Developing an Outline
* Preparing A Working Draft
* Reviewing and Refining
* Getting Approvals
* Finalizing and Publishing
Granted, each step of the above process can be a minefield of organizational politics and frustration for the writer, but the intent is not to over-simplify things. Instead, the aim is to provide the writer with a straight-forward starting point for developing and writing most common office manuals.
With this in mind, here are ten tips for writers to consider as they advance through the manual writing process:
1. Do not assume or presume common knowledge.
2. Write for potential users, not content experts.
3. Edit for clarity by eliminating vague and imprecise language.
4. Define terms or include a glossary.
5. Include an index. Make subjects easy to find.
6. Use varying fonts, colors, and bullets to add visual interest to text.
7. If illustrations are to be included, have them done professionally.
8. Ensure selected users and content experts critique drafts.
9. Build in a review and update schedule for the manual.
10. If none exists, set up a system for disseminating manuals and updates.
Jack
No comments:
Post a Comment