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.
RE: How do you define your audience/"user requirements" in your docs, to the reader?
Subject:RE: How do you define your audience/"user requirements" in your docs, to the reader? From:David Hailey <david -dot- hailey -at- usu -dot- edu> To:"Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 2 Apr 2008 12:34:21 -0600
Hi Leonard,
We are currently dealing with exactly this problem in one of my graduate classes. As we have examined a variety of digital documents, we find example after example where authors have failed to carefully describe their target audience even to themselves. The result is writing that is often on topic but directed toward inappropriate audiences -- this is especially true if they indulge in cut-and-paste composition. Moreover, their document design is often faulty as a result of directing document writing toward some generalized audience that doesn't actually exist.
When reading documentation, I find it useful to find a description of the document's intended audience. If I am not in that audience, I don't want to spend a lot of time with it.
What I usually see in well written books is a paragraph or two that describes the audiences in some detail, rather than trying to name them (e.g., "users"). Eliotte Harold's EFFECTIVE XML, for example, clearly explains that if you are not already pretty good with XML this book will not be very useful, then describes who will find the book useful.
My suggestion is that you understand all of the different purposes of your document, then describe in detail (rather than name) your different audiences.
If you fully understand your purposes, the audiences naturally follow. I suggest that writers should always do this. The advantages are two-fold: first, you understand the audiences well enough to focus your writing to their needs, and second, you know your audiences well enough to describe them in your document if it seems to warrant such a description.
David E. Hailey, Jr., Ph.D.
Associate Professor -- Professional and Technical Writing
Utah State University
dhailey -at- english -dot- usu -dot- edu
-----Original Message-----
From: techwr-l-bounces+david -dot- hailey=usu -dot- edu -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+david -dot- hailey=usu -dot- edu -at- lists -dot- techwr-l -dot- com] On Behalf Of Leonard C. Porrello
Sent: Wednesday, April 02, 2008 11:24 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: How do you define your audience/"user requirements" in your docs, to the reader?
All,
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.
Thoughts?
Thanks in advance!
Leonard C. Porrello
SoleraTec LLC
2430 Auto Park Way, Suite 205
Escondido, CA 92029
www.soleratec.com
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 david -dot- hailey -at- usu -dot- edu -dot-
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-
