Re: How do you define your audience/"user requirements" in your docs, to the reader?

["Michael West" <mbwest -at- bigpond -dot- com>]

"I was wondering how to deal with the challenge of defining my target
audience explicitly--in my docs, to the reader. I have hardware and software
requirements, but I do not have "user requirements," nor do I have a clear
idea of how to define my target user--to the reader. I have the standard,
"This user's guide is intended for users and system administrators," and
while "system administrators" is useful, "users" isn't saying much."
-------------------------

No, it isn't; and I don't know how you could have written a usable manual
without a clear idea of what roles you were writing for. And by "roles" I
don't mean job titles. I mean what they do -- what tasks they perform.

My suggestion is to define your audience in terms of what it is that the
manual you've written is supposed to help them do. Specific tasks, I mean.

"This manual is for people who need to do x, y and z using the
Superdupersystem."

Depending on the complexity and scope, you might want to delineate some
further boundaries:

"If you already have a basic understanding of <subject matter>, then this
manual is for you. If not, you should probably read <some other document>
before attempting to use the software."

Focus on the What rather than the Who  --- that way, it should become
immediately clear to the poor sod holding your manual whether it contains
anything he or she needs.

To find out more about your audience, you may need to speak to sales staff,
tech support staff, marketing staff -- or (drastic as it may sound!) the
poor users themselves.

Often the system developers know very little about the users. Sad but true.
On the other hand, that's why WE have jobs: to fill that knowledge gap.
--
Mike West
Melbourne, Australia






^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/ for more resources and info.