RE: Documenting a buggy feature (was: RE: techwr-l digest: April 30, 2002)

Subject: RE: Documenting a buggy feature (was: RE: techwr-l digest: April 30, 2002)
From: "Earl Cooley" <shiva -at- io -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 1 May 2002 16:44:51 -0500


Jim Shaeffer wrote:
> It depends <grin> on the point of veiw.
>
> From a documentation management point of view:
> Document it the way it is supposed to work and let the
> real world catch up.
>
> From a user advocate point of view:
> What are we doing releasing a product with a known bug?
>
> From a user service point of view:
> Of course you let the user know that they may need a
> workaround and what that workaround is.
>
> From a marketing point of view:
> Don't use documentation to highlight flaws in our product.
> Let the user work it out with tech support.
>
> Confession: I usually take the documentation management
> point of view. Many times our update or patch is in place
> by the time the user gets around to the documentation.

Now, that was a nice Roshomon moment. heh.

--
e=sc^3 (shiva -at- io -dot- com) Earl Cooley III

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com

Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr

---
You are currently subscribed to techwr-l as: archive -at- raycomm -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.



References:
Documenting a buggy feature (was: RE: techwr-l digest: April 30, 2002): From: Jim Shaeffer

Previous by Author: Re: Common instruction?
Next by Author: RE: Study: Internet Explorer Dominates the Web
Previous by Thread: Documenting a buggy feature (was: RE: techwr-l digest: April 30, 2002)
Next by Thread: Documenting a buggy feature (was: RE: techwr-l digest: April 30, 2002)


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


Sponsored Ads