RE: dispensing with documentation reviews

Subject: RE: dispensing with documentation reviews
From: Mailing List <mlist -at- ca -dot- safenet-inc -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 28 May 2004 09:25:45 -0400


Ann Pai wondered:
> I'd like your take on this from both ethical and practical
> perspectives.
> I've been given a friendly heads-up from management that we
> may need to send
> out a large documentation set for a relatively new,
> as-yet-undocumented
> product without review. Also, if the documentation isn't
> finished for the
> customers who want early product releases, I may be asked to "wrap up
> whatever I have" and send out the documentation as is. This
> includes a help
> system, user's guide, and setup guide.

You just described my situation.

We DO have the products and the documents properly QA'd
when we go to final release, but very often, there's a
"driving customer" for a specific feature/release, and
they need the product on their schedule, not necessarily
on ours. Also, they are willingly reviewing/testing the
product for us, and they'll often have some suggestions
with respect to the documentation, too.

It did raise my hackles just a bit, the first time I was
asked to do it, but as long as we eventually DO go through
a proper review/QA process, I'm OK with giving out preliminary
versions labelled "DRAFT". Besides, it's not ultimately my
call, and if anybody was going to get in trouble, it would
be the veep or the managers who sent me the original,
authorizing e-mails... which of course, I keep (including
copies off-site). :-)

/kevin (Ottawa, Canada)
--
The following text added by my employer, outside my control:
The information contained in this electronic mail transmission may be
privileged and confidential, and therefore, protected from disclosure. If
you have received this communication in error, please notify us immediately
by replying to this message, and then delete it from your computer without
copying or disclosing it.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo

>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more.
http://www.doctohelp.com

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Previous by Author: RE: Literate/Illiterate (WAS: Documenting installers?)
Next by Author: RE: tee-hee!
Previous by Thread: Re: dispensing with documentation reviews
Next by Thread: RE: dispensing with documentation reviews


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


Sponsored Ads