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: TECHWR-L Digest - 26 Aug 1997 to 27 Aug 1997 From:Robert Plamondon <robert -at- PLAMONDON -dot- COM> Date:Thu, 28 Aug 1997 09:09:38 -0700
>My questions are: Why are software fixes listed in a User's Guide?
>If they are fixes that are complete, they should be documented like
>any other program function. If they are yet-to-be-completed fixes,
>why are they included in documentation of the current product?
Such things don't belong in the user's guide -- they belong in
the release notes. Users of the previous revision need to know
about bugs that have been fixed so they can stop using the
product in an awkward, unnatural manner. Users of the current
version need to know about bugs so they can use the program at
all, albeit in an awkward, unnatural manner.
Few companies put their bugs in the User's Guide because it
gives the impression that the bugs will be an integral part of
the product throughout its lifetime (though this can be addressed
through formatting), creates a maintenence headache, and (in the
case of printed manuals) causes tons of printed manuals to become
wastepaper every time someone reports or fixes a bug.
-- Robert
--
Robert Plamondon, High-Tech Technical Writing, Inc.
36475 Norton Creek Road * Blodgett * Oregon * 97326
robert -at- plamondon -dot- com * (541) 453-5841 * Fax: (541) 453-4139 http://www.pioneer.net/~robertp
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
