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 and edit your docs
Subject:Re: What do you do when you don't have anyone with the time to review and edit your docs From:Bill Swallow <techcommdood -at- gmail -dot- com> To:Wade Courtney <wade -dot- courtney -at- gmail -dot- com> Date:Mon, 18 Jan 2010 19:43:41 -0500
I always send my material for review in chunks, set a deadline, cc the
appropriate managers, and set electronic reminders. I also follow up
in person early on in the review cycle, mainly as an unspoken reminder
that a real live person does in fact depend on them to review the
info. If there's no traction, the managers are contacted for a nudge.
If that doesn't work, I escalate.
Generally I try to avoid any form of conflict by planning the reviews
early on, identify the reviewers early on, and give everyone involved
a heads-up and set the expectations with them. I treat them as part of
the project, not part of the process, because... well, they are!
On Mon, Jan 18, 2010 at 2:27 PM, Wade Courtney <wade -dot- courtney -at- gmail -dot- com> wrote:
> Hi,
>
> I've just recently finished a user guide. I've sent it out for review, and I
> have reviewed and edited it many times myself, but I am at a point where I
> can no longer spot my mistakes. What do you do when there is no one to read
> your stuff, and they still want to push out the docs anyway without a proper
> review.
>
> I feel (sorry David) that they are going to come back to me and nail me for
> mistakes, even though they know that there wasn't a proper review. I have
> worked for employers in the past that expected perfection. I realize that
> this concept is not realistic, but it's still very prominent.
>
> Am I making sense? Does anyone have any advice?
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-