Re: Release notes and readme files

[John Posada <jposada01 -at- yahoo -dot- com>]

> "According to most of the development people I've worked with,
> there is no such thing as a bug.  It's just an undocumented
> feature."

I've never had a developer say this without smiling afterwards. A
developer knows a bug when they see one.

Back to the question...

The difference between a Release Note and a readme is timing. A
Release Note is a fully formed and formatted book containing Known
Issues, Enhancements, and Fixes since the last release, and a readme
is a text file containing everything that was discovered but was too
late to get into any of the documentation.

Example...I'm writing four Release Notes as we speak. An example of a
TOC of one of them is (about half of the items, proprietary, are
removed from the following example):

Introduction
  Enhancements
  Version Numbers
  Platform Support
  Product and Version Compatibility

Release Notes for <Platform>
  Installation/Uninstallation Issues
  Licensing Issues
  Issues on the Solaris Platform
  Issues on the Windows Platform
  Client Program Issues

Release Notes for <Product>
  Enhancements
  Fixed Issues
  Deprecated Features
  Known Issues and Limitations
  Installation
  Mandatory Patches

Included in both documents (RN and readme) are both operational and
installation issues.

John Posada
Senior Technical Writer

"I think the problem, to be quite honest with you, is that you've never actually known what the question is."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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 admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.