Release notes and readme files

Subject: Release notes and readme files
From: "egalite" <egalite -at- westnet -dot- com -dot- au>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sat, 21 Oct 2006 09:23:59 +0800

Hello fellow techwhirlians...

I've tried googling, and have read the 4 pages in the Microsoft style guide,
but information appears to be sparse.
Is anyone aware of a best practice guide on how to write release notes or
readme files? What's the real difference between them anyway? The MS example
kind of lost me.

My PM wants to produce release notes that basically contains a list of all
bug fixes. I'm not sure how useful this would be to an end-user, especially
if the product's not an off-the-shelf one (although it might be in future).

Also, any thoughts on providing the readme in a format other than text?
We're considering supplying it in PDF.

Thanks,
Trish :)

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

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.


Follow-Ups:

Previous by Author: RE: User Guide or User's Guide?
Next by Author: RE: Which product should we use?
Previous by Thread: Re: Showing sample and proprietary content
Next by Thread: Re: Release notes and readme files


What this post helpful? Share it with friends and colleagues:


Sponsored Ads