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.
RE: What do you do when you don't have anyone with the time to review andedit your docs
Subject:RE: What do you do when you don't have anyone with the time to review andedit your docs From:Paul Hanson <phanson -at- Quintrex -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 18 Jan 2010 15:59:43 -0600
Do you include your Customer Support dept in your review cycle or is it only Dev and QA?
I include Customer Support but wondered if anyone else does as well.
Paul
-----Original Message-----
From: techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Suzette Leeming
Sent: Monday, January 18, 2010 3:57 PM
To: TECHWR-L
Subject: Re: What do you do when you don't have anyone with the time to review andedit your docs
I have a similar problem. I finally refused to release any documentation
that had not been reviewed.
Now the SMEs review my documentation so that it can be released but they
either don't look too closely, or they comment on grammar (shouldn't you
have a comma here?) instead of technical accuracy. BTW, during the review I
ask them to focus on technical accuracy, not grammar.
The difference though is that when my boss comes back to me with a customer
complaint that something doesn't work the way the online help says it does,
my standard response is, "Then why did the SME approve it?" That throws the
ball out of my court.
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
