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.
Donna,
For our online help, we used to provide both a CHM and a PDF; lately our network has taken to blocking CHM files, so we tell them where they can find a draft copy on a shared server. The PDF is set up for commenting. Our email distribution identifies who is responsible for reviewing each section of the help and who is invited, as an optional reviewer, to contribute to the review. The reviewers are given instructions on how to use the PDF markup, they're directed to a document that describes the review process, and they're given a strict deadline.
It's taken us about seven years to get a fairly consistent response to the review process, and we're a fairly static company (not a lot of turn-over, I'm working with several guys who have not only worked for the company but worked in the same jobs for more than 25 years).
Occasionally, we meet with project teams and go over what our expectations are (generally with new teams or important projects to ensure they are on board and understand the process) and what the process is for introducing change.
We have incredible deadlines for Help because ALL 22 languages have to be integrated into the software before the final cycle of testing.
HTH,
Wanda
Wanda Phillips
Senior Technical Writer
Don't be afraid, Jellybean: Quod non est in actis, non est in mundo
-----Original Message-----
From: techwr-l-bounces+wanda -dot- phillips=philips -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+wanda -dot- phillips=philips -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Donna Marino
Sent: Wednesday, September 16, 2009 9:11 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Review process for online help
I've developed a large online help system and it needs to be reviewed by the SMEs at my company. This is the first time the help is going through a review and it's going to take a bit of work to get everyone on the same page about the review process and its value.
What have you found to be the best and most efficient way to elicit feedback from subject matter experts? Do you distribute materials to be reviewed as a printed document, a PDF, or some other format? (I ask this because one developer likes to have a paper copy so he can actually write notes on it.) Any suggestions about useful review processes would be greatly appreciated.
thanks,
Donna
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices. http://www.doctohelp.com/SuperPages/Webcasts/
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as wanda -dot- phillips -at- philips -dot- com -dot-
The information contained in this message may be confidential and legally protected under applicable law. The message is intended solely for the addressee(s). If you are not the intended recipient, you are hereby notified that any use, forwarding, dissemination, or reproduction of this message is strictly prohibited and may be unlawful. If you are not the intended recipient, please contact the sender by return e-mail and destroy all copies of the original message.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices. http://www.doctohelp.com/SuperPages/Webcasts/
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
