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: Suzette Leeming <suzette -dot- leeming -at- gmail -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 18 Jan 2010 16:57:15 -0500

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.

Every year the reviews get better...

Suzette Leeming
Ontario
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
What do you do when you don't have anyone with the time to review and edit your docs: From: Wade Courtney
Re: What do you do when you don't have anyone with the time to review andedit your docs: From: Gene Kim-Eng

Previous by Author: Re: too narrow or too-narrow?
Next by Author: What do you call wordless technical procedures?
Previous by Thread: Re: What do you do when you don't have anyone with the time to review andedit your docs
Next by Thread: RE: What do you do when you don't have anyone with the time to review andedit your docs


What this post helpful? Share it with friends and colleagues:


Sponsored Ads