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:"Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com> To:"John Posada" <jposada99 -at- gmail -dot- com> Date:Wed, 2 Apr 2008 11:35:26 -0700
Yes, yours have been my working assumptions and approach. However, our lead developer put the question to me today, and it got me thinking. Perhaps it could be helpful to the user to understand whether or not the documentation is targeted at him (granted the user reads the intro sections). For example, "To understand this guide and successfully use the application, the users should be versed in using Windows XP." That appears to be better than the original statement (below), but it is still problematic. Even apart from the issue of meta-cognitive competence, "Versed" means different things to different people. Same with "beginner," "intermediate," and "advanced." So, does the statement really add anything? On the other hand, you can't say, "Despair of using this product all ye who have an IQ of less than 100 on the WAIS-III scale."
Leonard C. Porrello
SoleraTec LLC
www.soleratec.com
________________________________________
From: John Posada [mailto:jposada99 -at- gmail -dot- com]
Sent: Wednesday, April 02, 2008 10:51 AM
To: Leonard C. Porrello
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: How do you define your audience/"user requirements" in your docs, to the reader?
>> nor do I have a clear idea of how to define my target user--to the reader.
You don't have to define your target reader to your user. If they picked up the manual and are getting use from it, they ARE the target. What you need to do is to not miss ones you should, and not waste time writing for someone who couldn't care. By having an accurate understanding of who will be pickikng it up, it will be written for them when they do.
I like to do this by defining personas, then write to the ones that apply.
John Posada
Senior Technical Writer
NYMetro STC President and Program Chair
- Said the Zen master to the hot dog vendor "Make me one with everything."
On 4/2/08, Leonard C. Porrello <Leonard -dot- Porrello -at- soleratec -dot- com> wrote:
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.
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-
