Re: Best Documentation

Subject: Re: Best Documentation
From: "Dan Roberts" <droberts63 -at- earthlink -dot- net>
To: "Tracy Boyington" <tracy_boyington -at- okvotech -dot- org>, "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 7 Feb 2000 16:47:03 -0500

>> When was the last time that you participated in or witnessed a tech comm
>> project that fell apart because of poor writing skills?
>
>I have seen a project that had to be rewritten because, while the
information
>was probably correct, the document was so poorly written that it was
unusable. I
>have also seen a project that had to be rewritten because it was entirely
>inappropriate for the target audience -- writing for a particular audience
is
>part of writing skills.


I'm in the same process myself. Although the 'project' never fell apart,
this particular manual is apparently despised by at least one VP, marketers,
consultants, doc staff, and most everyone else, except the developers. I had
to reread paragraphs and sentences multiple times, in order to cut through
thickets of verbage to get to the core information, which, oftentimes, was
sadly lacking. I dont know anyone that could use this book to get their
tasks done except serious MVS JCL junkies.

Of course, this particular manual could also have benefited from some
serious user-based task analysis, also.

Oh well, back to the fray.








Previous by Author: Re: History of TW before the PC and the Internet
Next by Author: RE: managing really good people who are also passionate
Previous by Thread: Re: Best Documentation
Next by Thread: Re: Best Documentation


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads