Re: Release notes: term for bugs
* Known issues
* Known problems
The term "undocumented enhancement" was once recommended to me, but to this day I don't know if the guy was kidding or not.
If possible, include work-arounds. Mmmm, I just had a thought. How cost-effective is it to include bugs in a print manual. Wouldn't that information be better kept in electronic format for easy update (when possible). I don't think we ever included bugs in the print docs I did.....
That's brings up a question, how do you all typically handle the inclusion of bugs in documentation? Just curious.
********************************************
Sean Hower - tech writer
http://hokum.freehomepage.com
"Whatever you do, do NOT let your editorial decisions be made by the squiggly spell-checking lines in Word!" ~Keith Cronin, Techwr-l irritant ;-)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
---
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:
re: Release notes: term for bugs: From: Sean Hower
Previous by Author:
Re: Release notes: term for bugs
Next by Author:
Re: Single vs double quotes?
Previous by Thread:
re: Release notes: term for bugs
Next by Thread:
RE: Release notes: term for bugs
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads