RE: Do Document Reviews Provide Significant Feedback?

Subject: RE: Do Document Reviews Provide Significant Feedback?
From: "Sharon Burton" <sharon -at- anthrobytes -dot- com>
To: "Tony Markos" <ajmarkos -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 29 Dec 2005 09:28:44 -0800

A review as late in the game as the one under discussion should never result
in a reorg. The doc should have been planned and approved before writing
started. Everyone should have been aware of what was going in the manual and
in what order long before the writing started. This should be the technical
review for accuracy.

At this point in the review process, the specific review under discussion
should result in catching inaccuracies, incorrect information, concepts not
clearly described, vague conceptual graphics, inaccurate procedures, and
identify holes. (Oops! We explained how and why you want to restrict user
policies but forgot to tell them how and why that impacts reporting!)

But that's how I ran my business and am now running a group for my employer.
It's not how everyone does it. Not doing it this way can result in a chaotic
review process. And it also depends on the care reviewers take, which can be
a result of corporate culture. We've all had the technical reviewer who
"fixes" grammar and spelling and ignores the technical content.

The beauty of planned docs in the review process is you get to smile at
people and say "Yes, I can see that you think this 600 page manual that
needs to be in the build in 2 weeks should be gutted and restructured. It's
too bad you didn't raise this issue at the planning meetings you attended.
But I'm looking forward to your input on this issue at the planning meeting
for the next version of the product."

It's a lovely feeling.


sharon

Sharon Burton
CEO, Anthrobytes Consulting
951-369-8590
www.anthrobytes.com
Immediate Past President of IESTC

-----Original Message-----
From: techwr-l-bounces+sharon=anthrobytes -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+sharon=anthrobytes -dot- com -at- lists -dot- techwr-l -dot- com]On
Behalf Of Tony Markos
Sent: Thursday, December 29, 2005 8:49 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Do Document Reviews Provide Signifcant Feedback?


Question to all listerv members:

Someone recently posted about having people review
his/her up to 600 page manuals. Can such reviews
result in significant feedback such as reorgan1zation
suggestions or the filling of logical "holes", or will
feedback on text be limited to minnor corrections?

Tony Markos



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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com

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

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


Follow-Ups:

References:
Do Document Reviews Provide Signifcant Feedback?: From: Tony Markos

Previous by Author: Re: Formatting Docs On-The-Fly
Next by Author: RE: Do Document Reviews Provide Significant Feedback?
Previous by Thread: Do Document Reviews Provide Signifcant Feedback?
Next by Thread: Re: Do Document Reviews Provide Significant Feedback?


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

Sponsored Ads


Sponsored Ads