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

Subject: Documenting a buggy feature (was RE: techwr-l digest: April 30, 2002)
From: "Barb Einarsen" <barb -dot- einarsen -at- nettest -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 1 May 2002 10:49:37 -0400


Yes, and that section is the "Troubleshooting" section.

Alternately, if your company does not want such information in the
manual, you can give the "Troubleshooting" material to your technical
support department.

Here most bugs disappear by the time we ship the product, even if they
appear while the manual/help is being written. We tend to write the
manuals the way in which they should (will) work. We add a
Troubleshooting section for any known difficulties (bugs or possible
user errors) that won't be fixed in time for the release. We also create
Technical Advisories for Technical Support and Service after the
release.

Barb

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.



Previous by Author: AW: Is Photoshop a good tool for screenshots?(long)
Next by Author: Re: writing tests are for wussies...
Previous by Thread: RE: Documenting a buggy feature (was: RE: techwr-l digest: April 30, 2002)
Next by Thread: Need Help With My Proposal


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


Sponsored Ads