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:Caroline Tabach <caroline -dot- tabach -at- gmail -dot- com> To:Wade Courtney <wade -dot- courtney -at- gmail -dot- com> Date:Tue, 19 Jan 2010 15:11:32 +0200
There are a number of things:
1. Send with an email, "if I do not get comments by Thursday I will
assume that you approve the user guide and this will be distributed."
2. Send a mail with cc to all relevant people that the book has been
sent for approval and since x had no comments it will be published.
In both ways, the SME is now responsible.
The other thing to bear in mind is that each person has different ways
of reviewing material.
Some people like to mark up a PDF, others like to write on a print out.
For some it is enough to send an email, for others you yourself have
to print out the material for review and go to their office with a
hard copy. So maybe if they did not answer mail, maybe they will
react to a print out that you wave in front of their face (physically)
Often, you have not written an entirely new book, but just updated sections.
If only part of a book has changed, it is often useful to send only
the new sections for review and not the complete book
On Mon, Jan 18, 2010 at 9: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
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-