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: "Know thy audience"; was: RE: What is "well Written"?
Subject:Re: "Know thy audience"; was: RE: What is "well Written"? From:"David Neeley" <dbneeley -at- gmail -dot- com> To:"John Posada" <jposada01 -at- yahoo -dot- com> Date:Mon, 21 May 2007 14:58:17 -0600
John,
You addressed a different point than I did. Perhaps I wasn't clear enough...
The "discovery" of which I was referring was that of the *user* of the
documentation. They turn to the documentation, by and large, to figure out
how to accomplish one or more tasks, or perhaps what tasks they need to be
doing at a given point in their work. I believe it is our job to make that
discovery process as effective and trouble-free as possible.
Your point, I think, is quite different--how to discover the most effective
methods of reaching the target audience, and how to test various solutions
to be sure you are getting the best one. Those are obviously not invalid
points, just different ones.
David
On 5/21/07, John Posada <jposada01 -at- yahoo -dot- com> wrote:
>
> Sorry for the delay in responding...deadlines, ya'know?
>
> anyway...
>
> > It is our function, among other things, to create
> > documentation that makes the discovery of what to
> > seek a straightforward task with a minimum
> > of frustrations. (Also why a good index is a godsend,
> > to respond to yet another current thread!)
>
> Documentation makes no discoveries...you need to make your
> discoveries and, in my opinion, can only do it WITH documentation by
> testing how it is used, examining the results of the tests and making
> continual improvements to the documentation based on the tests.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-