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: Peer Review Process/Best Practices From:wendy_lewis -at- goodyear -dot- com To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 27 Feb 2008 15:28:48 -0500
I used to work at a software development company that had a unique review
cycle. Never in the 7 years I was there, did anyone read a whole manual.
Maybe small sections. So I was pretty much the writer and editor, final
answer, and all that.
At some point, someone noticed.
The boss had me print ALL of my manuals, about 20, and took me and all
10-15 engineers to Starbucks. He opened an account and made the engineers
sit there and read the manuals. We had a variety of colored pens and no
doc was complete till it had two different reviewers mark it up and sign
off. They thought it was going to be a slack off day. HA!
It also kept me busy for months afterwards cleaning everything up.
Wendy Lewis
>
> Is there anybody out there using a slightly formalized process for
getting
> documents reviewed prior to delivery? If you are, can you share some
best
> practices?
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-