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.
> From: train2 -at- sprynet -dot- com asks:
>
> So...how do we know what we write is useful and readable?
> Are there methods for checking? Who tests the documentation?
> Looking for a little feedback here.
We use a three draft system where there is testing/review after each draft.
OK, I lied, don't quite use this system yet, but we are going to with the
next new project or revision of an existing project.
After developing a doc plan, gathering initial information, outlining the
doc, and building a doc shell in Frame, a first draft is written. This first
draft goes to QA. They test it as they test the product, mark it up and
return it. Then a second draft is written. It goes to the SMEs (generally
programmers and/or support techs) for a technical review. They mark it and
return it. Then a third draft is written and while the editor is doing
his/her thing, it goes to the SMEs one last time. Each SME has to sign off
on it stating that they have carefully read through and can vouch for it's
accuracy. Then any additional comments from SMEs are on integrated into it
and a final edit is done before producing a final PDF for print production.
_________________________________
Steven Shepard
Manager, Documentation Group
Yardi Systems, Inc.
819 Reddick Avenue
Santa Barbara, CA 93103
805/966-3822
steves -at- yardi -dot- com
www.yardi.com
IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15. http://ieeepcs.org/2001/
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
