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: Readme files with references to fixed bugs From:"Dana Worley" <dana -at- campbellsci -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 21 Aug 2001 12:12:53 -0600
> We have an internal database in which we log bugs (er....issues).
> There are sometimes hundreds of issues logged per release, and some of
> them are just typo fixes, etc. It would be difficult to decide which
> fixes are important enough to be listed, and I really don't think we
> want to list them all.
I think if you look at it closely, it will be relatively easy to determine
which problems should be included in the readme.txt.
What resolved issues have had a significant impact on your users
(or have the potential for significant impact)?
What are the issues that drove the new release of the product?
Most likely, you have bugs in your data base that would be nice to
have fixed but are not crucial, so they don't warrant a new release
by themselves. There are other issues, however, that are part of the
reason for a new release. These are the items to outline in a
readme.
What significant functionality was added?
I think you have to look at what is most important to your users
and weed out all the "noise" (typos, additions to documentation,
etc.)
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. 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.