Writing
Technical writing is specialized, structured writing.
You may need a comprehensive documentation plan including procedural and reference documents (User & Reference Manuals), User Guides & Desktop Aids, Procedures and Online Help. Or a quick fix to your current documentation.
How material is presented impacts what is written
Users are only as good as their Documentation
Guides
User Guides are brief and to the point, getting the user up and running quickly.
Manuals
Manuals describe what the product does and how to do it. They provide deeper understanding to the system and how to accomplish tasks.
System Documentation
Functional Specifications
Written by designers and analysts with the collaboration of users, describe what tasks the system should perform.
Design Specifications
Written by analysts for programmers, describe how the system performs the required tasks.
Technical Specifications
Written by programmers, describe how the program functions.
Accurate and complete Specifications ensure system continuity. A Professional Technical Writer ensures that these important documents are accurate and complete.
Maintenance
Documentation development continues as long as inaccuracies, customer dissatisfaction and usability issues continue. Electronic (Internet) and Desktop Publishing provide the means for inexpensive and immediate updates and corrections.
The Internet adds a whole new level to documentation
User and client feedback (via FAQs, forums, blogs, help desk logs) is compiled, analyzed and updated online.
Why Developers Can’t Write Documentation
Developers take an internal view. They understand the product thoroughly and make assumptions about how much the user understands and what they want to know.
Write Documentation from the User’s viewpoint
Developers may code a great system but can they write clear instructions?
Are your best people doing work better left to others?
|
New York Tech Writer