[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Release notes and readme files

Subject: Re: Release notes and readme files
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "egalite" <egalite -at- westnet -dot- com -dot- au>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sat, 21 Oct 2006 11:28:09 -0700

Generally speaking (because there is no "standard") "release notes" are
a history of changes and for each release document as many changes
as you think your reader will care about (and it's not unusual to have
different release notes for internal and external use), while "readme"
contains late-breaking information developed or discovered between
the moment you completed your user docs and the moment the
product was actually packaged or something users need to know
before their first use of the product.

Gene Kim=Eng


----- Original Message ----- From: "egalite" <egalite -at- westnet -dot- com -dot- au>

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.

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

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.

References:
Release notes and readme files: From: egalite

Previous by Author: RE: Re: Showing sample and proprietary content
Next by Author: Re: Showing sample and proprietary content
Previous by Thread: Release notes and readme files
Next by Thread: Re: Release notes and readme files

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads