TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:FWD: Who is my audience? From:Damien Braniff <Damien_Braniff -at- PAC -dot- CO -dot- UK> Date:Wed, 29 Oct 1997 14:41:56 +0100
One question immediately springs to mind - why are you only allowed one
"set" of docs? Is this financial constraints or simply the view that you
only need one?
If you ARE really limited to one I feel that you have two options:
Document everything in all its glory and put most people off - they
probably won't read it.
Decide who makes up the vast majority of your audience and write from
them. Essentially exclude those you feel won't use it anyway - a
Ideally you want THREE types of documentation (could be phased in over
Reference manuals that cover everything. Provide info for those that
want to get to the nitty gritty - all those lovely features that others
never even knew existed.
A "Quick Reference User Guide" - possibly small A5 manual detailing the
MAIN features that everybody uses. Should be small enough not to put
people off using it. With something like this I've found that people
feel happier going to a reference manual(s) for more if they need it.
As long as the original lit isn't off-putting.
On-line version of (1) and (2) combined. May even get away with
skipping (1). Ref manuals with cue cards for common features.