The Absolute Minimum 10 things a tech writer MUST do-Raghunath Soman

Learn the tools0 If your project requires a specific help authoring tool,

learn it thoroughly - either on your own or with help of a mentor

0Learn a good graphic tool (SnagIt and/or Visio)0Learn how to use version control and CMS.0Learn how to create a good-quality index0Learn shortcuts for frequently used functions0Last, but not the least: Learn to type… without looking

at keyboard!

Learn the technology

0Contrary to what you may think, you MUST learn the jargon! This helps immensely in talking with the SMEs in their own language.

0 If you are working on a long-duration project (> 6 months), try to find out as much as you can about HOWs and WHYs of the product.

Get access0Get access to:

0 The location where daily release builds are shared0 The project e-mail alias0 The bug tracker0 The version control system (VSS/SVN..)

0Access to these becomes increasingly critical as the release approaches

0 In turn, provide quick and easy access to your documentation

Use the product

0Learn how to install and configure the product on your own.

0Use the product… not just superficially, but really hack it.

0 If you find any issues, log a bug into bug tracker or share it with a QA.

0Suggest improvements in UI, error messages, usability.

Read the Damn Manual

0No, not the user manual… That’s something YOU are going to create, right?

0Read all the available documentation, especially the High Level Design and Functional Requirements Specs

0 If you find something in the docs that’s NOT a part of the product, talk to a dev.

Use Checklists

0Checklists are not something that you create at the end of the project, they should evolve with the project

0Checklist should be atomic, that is broken down to the lowest level possible

0No deliverable should be sent out unless it has passed though a comprehensive checklist

Befriend the QA

0QA team is the usually best source of information regarding the product.

0 In exchange for their time for product KT, offer to share with them any bugs you may find

Build and Test

0 Insist on including the documentation from first build of product, in whatever state it is.

0Do usability testing of your documents. If YOU can’t install a product by following your own installation guide, chances are, users won’t be able to, either!

0Ask your friendly QA to review your document, and encourage them to raise bugs against you in the bug tracker.

Read0Your writing often reflects the depth of your reading;

Read voraciously.0Harness the power of Web; read blogs, technical sites

and user communities

Keep Writing

0Keep writing… and not just technical writing.0Write a blog, contribute an article to your company

newsletter, respond to queries in online forums.0Write some fiction; write a bit of poetry.0Writing is like driving; the more you practice, the

better you become at it.

Thank You!