Re: Release notes and readme files

[Steven Jong <SteveFJong -at- comcast -dot- net>]

When writing release notes/readme files, one important distinction to  
make is between bugs found by customers and bugs found during  
testing. The former should wind up in the release notes in one of  
three places: if it was fixed, as a bug that's been fixed; if it  
hasn't been fixed yet, as a known issue; if it's not going to get  
fixed, as a clarification.

The latter category--bugs found during testing--can become known  
issues or clarifications as well. But if a bug is found and fixed  
during testing, there's no reason to include it at all; it's a  
"virtual bug" that doesn't exist to customers. For every bug the  
customers find, there were probably ten found in the builds; why  
scare people?

If after discarding "virtual" bugs you still have a substantial list,  
you have a problem with your development process, not your release  
notes.

                -- Steve


Steven Jong (Subveni, Domine! Habemus aliam felem!)
SteveFJong -at- comcast -dot- net
978-413-2553 [C]
Home sweet home page: home.comcast.net/~stevefjong


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help 
format plus PDF, HTML and more. Flexible, precise, and efficient content 
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.