How To Write Technical Instructions

how to write technical instructions"how to write technical instructions"

WHAT'S WRONG WITH THE CURRENT APPROACH TO TECHNICAL WRITING?

It's Boring.  Simple.

Who likes to wade through abstruse descriptions of how a button works, how a product screen looks, or worse still (the technical writer's ultimate attempt at being user-friendly) how to accomplish a task?  The problem with the technical writing community is that they don't read through what they've read from the user's perspective.

Let's be fair – technical writing and florid language just don't go together; and they shouldn't.  There's too much scope for inaccuracy creeping into the technical description.  That's why technical writing manuals such as the Chicago Manual or the Microsoft Manual are absolutely rigid about the language used, the terminology and the flow of the document.  While this is really important, most people forget that technical writing services are used to make products sell.  It's important to sugar-coat the product description so that it becomes easy to use and understand.  Remember – a very large part of the end-user community is non-technical.  Even the technical community welcomes a breath of fresh air when reading through really technical stuff.  A case in point – you don't really get much more technical than Nanotechnology.  Yet, there are a number of authors who have treated the subject with so much finesse, yet gentle humor that reading through such a heavy topic becomes little more than bedtime reading!

Can we import the same cushioning into technical writing for IT products?  Admittedly, it could be challenging.  However, judicious and intelligent use of graphics, animation and innovative presentation could do wonders to increase the palatability, and hence the sale of a technical product.  Technical writers often complain that they aren't given the kind of respect that they deserve.  That respect can be earned, easily, if they are able to demonstrate how their documentation can increase the product sale dramatically. Intelligent innovation could go a long way in achieving this end.

About the Author

Mr. Tabir Mishra is the Deputy General Manager  of a well-known technical and content writing company named ConWiz, and has a number of years of experience in delivering and managing content-related projects.  To know about the company services in Technical Writing, Content Management, Instructional Design etc. please visit www.conwiz.in.

Why write a Quality Manual?


how to write technical instructions
how to write technical instructions