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.
> 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.
We do it differently.
Readme might detail some new stuff, or might mention some specific
thing that we didn't have time to fix, where it'll make your life
easier if you "do the following..." But the important thing is
that a readme is on the CD, meaning that it is what QA received...
meaning that it was cast in stone many weeks before actual final
GA (General Availability release).
Our release notes have much of the info that John describes
(arranged slightly differently) and all the news that's fit
to print about previous-release issues that have now been
addressed and about new issues (bugs) that:
a) were discovered during testing, but weren't deemed serious
enough to scuttle the release or,
b) were known before QA, but we needed to get the release
out and they were (again) not serious enough to be deal breakers.
So, all open issues must be either low-to-medium priority
or, if they are high-priority, have a viable workaround. If they
are higher than high...critical, no workaround... then they are
deal breakers, and the release doesn't go out until they're killed.
The readme.txt points to the Release Notes.
Anyway, our Release Notes don't go on the CD (or the tar file
if it's distributed that way). The Release Notes go on the
Customer Support website, and the CD (or tar file) contains
a link to the Release Notes. That means they can also be
updated between releases if we - or a customer - discover
something else worth mentioning, and we don't want to wait
until the next release.
Kevin
The information contained in this electronic mail transmission may be privileged and confidential, and therefore, protected from disclosure. If you have received this communication in error, please notify us immediately by replying to this message and deleting it from your computer without copying or disclosing it.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
