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.
Subject:Re: Best Practice for reviewing documents From:Steven Brown <stevenabrown -at- yahoo -dot- com> To:"Lucero, Peggy" <plucero -at- atsva -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 20 Dec 2005 05:29:13 -0800 (PST)
If time allows, I try to schedule a meeting for all of
the reviewers to attend. An interesting back-and-forth
occurs when you have your SMEs gathered and they start
to bounce comments and corrections off each other.
What might have been a black and white issue may turn
out to be more complicated (and thus require more
substative documentation).
This also raises your role from that of an editor to
something akin to a facilitator/troubleshooter.
> I have numerous technical documents that are mostly
> written by the team
> member responsible for and working daily within
> subject area of said
> document.
> After the developer finishes his writing/delivering
> content, document
> then needs to go through peer review and then be
> reviewed by the client.
> Each of these reviews is likely to result in
> changes/deletions/additions/recommendations, etc.
> all done in WORD with
> tracking changes on.
>
> During the review process, how many times should I
> be reviewing the
> document and making editorial changes? I have been
> advised that the'
> subject matter expert' for these documents, the team
> lead for
> operations, needs to make his review of documents
> after peer/client
> reviews to accept their
> changes/additions/deletions/recommendations as
> only he is in a position to judge the technical
> accuracy. Of course, I
> am the only person on this team in the position to
> judge the spelling,
> grammar, sentence structure, punctuation, layout,
> format, etc.
> Boss says that after the client reviews document and
> makes their
> recommendations document should not be changed.
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around http://mail.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-