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.
To: techwr-l @ listserv.okstate.edu
cc:
Subject: errata coverage
One problem with including errors in the "heart of the manual" is that
they'll be buried, and many folks won't see them. I would say they at
least deserve a mention in the Release Notes (even along the lines of
"Please see the sysadmin manual for information on. . ."), because I do
think most folks at least give that a quick scan.
To satisfy both parties, however, you could have an appendix called Errata,
Troubleshooting, or whatever, in Sys Admin that was basically a copy or an
expansion of what you covered in the release notes. Maybe even just cut
and paste it over. That'll make everyone happy! (If only *that* were
possible!)
IM very HO,
Cathy
Cathy Carr
Documentation Specialist
Ovid Technologies, Inc.
1/212/563-3006 or 1/800/950-2035 (ext. 323) http://www.ovid.com
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
