
December 18th, 2006, 01:02 PM
|
 |
|
|
Join Date: Jun 2006
Location: Salem, OH
|
|
Writing technical documentation is an art form. As a professional writer, I can tell you without reserve it's something that takes a long time to learn. Just remember these basics things: - Present your readers with the information they need to know. This can include product specs, operating and care instructions, and safety warnings.
- Be as clear and concise as possible. You want to avoid any confusion. Also, being long winded defeats the purpose.
- Answer any possible questions. Try to image what types of questions or scenarios might arise during the use of the product. Cover these questions or scenarios in your documentation.
This should give you some things to keep in mind. Other than that, learn by example. Look at documentation for similar or competitor's products.
__________________
 Click the image if at any point you don't like my decision.
Scripting problems? Windows questions? Ask the Windows Guru!
|