dispensing with documentation reviews

Subject: dispensing with documentation reviews
From: "Ann Pai" <apai -at- kc -dot- rr -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 27 May 2004 23:36:57 -0500


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. Because our other writer is facing a
similar situation, it appears to be a trend: it's okay to send out
unreviewed or even incomplete documents as long as we label them "early
release."

Because our developers often do all the testing of "early release" software
outside the formal QA cycle, it's possible that management sees no practical
difference in the writers doing their own cleanup and proofing of an "early
release" document. I haven't been able to persuasively articulate a
difference so far. (Our "early release" customers usually expect some
software features to be incomplete because they're getting the product
early.)

What are my options for appropriate responses? Am I wrong, or unrealistic,
to take a hard line on this? I've expressed my discomfort with unreviewed
documents going out the door. I also plan to review our standard licensing
agreement ASAP to make sure we disclaim the documentation as an express
warranty.

Thanks for any help you can give me.



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

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.



Follow-Ups:

Previous by Author: Re: Arrogance (Was single spacing...)
Next by Author: Re: life imitates techwr-l
Previous by Thread: Adobe Table in PageMaker
Next by Thread: Re: dispensing with documentation reviews


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


Sponsored Ads