How to Write Technical Documents for the Intended Audience

By Ugur Akinci

There is no such thing as a single “user guide” or “product manual” in technical documentation. It all depends on the audience you are writing for and their specific interests.

For example, imagine you are writing a “software manual” for software that audits medical insurance claims.

Here are the interests of different groups of readers in this same product:

Table of Contents

Shareholders

How will this software influence the price of shares? Will it help us realize a healthy ROI (Return on Investment)?

Executives

How will this software earn us more money and help us meet our quarterly revenue and profit projections?

Marketing Managers

How will this software help us expand our market share while keeping our overhead and future capital investments to a minimum?

Project Managers

How will this software help us differentiate ourselves in a market dominated by brands X and Y, and recapture 34% of the small businesses that we’ve lost over the last 3 years in the Western Region?

Product Managers

Will this software audit 78% more claims per hour and capture 50% more fraudulent claims, and thus increase the profits of our insurance clients?

End Users

As an insurance adjuster, will I be catching 50% more fraudulent claims with this software without investing more than $1,000 per worker for re-training?

Technical Department

How frequently would we have to update this software? Would we have to buy new servers and any new routers? How long does it take to install and configure it for 5 or fewer sites, or for more than 5 sites?

Customer Support

Will this software reduce the number of calls we receive from doctors regarding disputed claims? Does it come with a handy help file that is context-sensitive?

Data Entry

How rapidly can I enter claim data into this software? How intuitive are the individual screens? Can I configure the menu and tool bars depending on the kind of medical bills we get?

Obviously, not all these interests are mutually exclusive and they do overlap. But you get the idea…

So as you can see, different audiences have wide-ranging expectations regarding the same product. The “manual” you write should be appropriate for the intended audience.

Otherwise, your work will be tossed aside as irrelevant, and for good reason too.