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: Standard Doc Review Cycle-Online/Print Help From:"Gurpreet Singh" <gurpreet2311 -at- gmail -dot- com> To:doc -at- edwordsmith -dot- com, ghart -at- videotron -dot- ca Date:Wed, 5 Jul 2006 18:42:36 +0900
Thanks a lot for the information, Ned and Geoff.
I got some good ideas about the whole process. Please find my comments inline.
Geoff,
Let me first thank you for the link to your article. The article was
great and it provided a much-awaited direction to my thoughts. Thanks
once again.
Quote
"I'm sure there are specific standards for specific industries, but
you'd have to name the actual industry you're working in to get
focused advice."
I work in Electronic Test and Measurement industry. However, my basic
interest is in a flexible review process for documentation, for both
print and online help. I'm concentrating not on the writing part but
on the review process; like peer review, technical review et al. Do we
have a formal process for this?
In addition, is 'document review cycle' industry dependent?
Ned,
Thanks a lot for the information. It really helped a lot. I tried
googling a lot but failed to get some real world processes. The
processes described are great, if we can follow them exactly in the
real world. Unfortunately, the gap between theories and realities
still exists.
Most of the listed processes are good but impossible to follow, partly
because reviewers have very limited time and we can't ask for more
than our share. Unfortunately, that share is very less as well and
which is why I want to create a process so that this time is used
effectively.
I thought to start with the standard processes first, and then keep
fine tuning those processes to fit my needs.
I really liked the doc freeze idea. I wonder if it is 100% effective
in my organization.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList