TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:RE: Title for a document about bugs From:"David M. Brown" <dmbrown -at- brown-inc -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 07 Mar 2001 07:28:15 -0800
Kerstin -dot- Molthagen -at- etas -dot- de wrote:
>
> My favourite would be "Known Issues/Problems" if the document is a mere
> listing of the bugs, and "Troubleshooting" if workarounds are given.
I think of "Troubleshooting" as a place to look *after* there's a
problem. If there's a problematic behavior that can be *prevented*
I'd rather be told about it beforehand.
That's the sort of thing I'd expect to see in a section called "Known
issues" or something similar. There's no reason such a section couldn't
include workarounds, too.
As for what to call the document, it seems like all of this information
belongs in the release notes, along with the "good news" (new features,
enhancements, bugs fixed, and the like).
--David
=============================
David M. Brown - Brown Inc.
dmbrown -at- brown-inc -dot- com
=============================
IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15. http://ieeepcs.org/2001/
---
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.