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.
> Hi! techies,
>
> We are launching a new product next week. The product documentation
> contains overview of the product, installation procedure, limitations of
the
> product, FAQ, Bug reporting and feedback and contents.
>
> Do we call this product documentation as "Release notes"? But Release
notes
> is prepared when a new version of the product is released - is it so?
>
> Please suggest a name for this product documentation.
You can call them Release Notes, even though it's Version 1.0. You're still
releasing the software. I don't think there is an industry standard for
what constitutes Release Notes (or any other documentation, for that
matter...)
In our company, Release Notes are a simple Notepad document, often called
readme.txt. It accompanies a zipfile that contains the rest of the
documentation associated with the release. The readme.txt provides a brief
overview of the release, especially if it's an update of an earlier software
release, plus instructions on the documents in the zipfile -- installation,
ops docs, whatever. It is pretty much an "open me first" sort of document
that leads the recipient to get the software up and running.
Paul Strasser
Windsor Technologies, Inc.
2569 Park Lane, Suite 200
Lafayette, Colorado 80026
Phone: 303-926-1982
FAX: 303-926-1510
E-mail: paul -dot- strasser -at- windsor-tech -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to
RoboHelp for FREE, through January 15th. RoboHelp can import your existing
Help projects! Learn how else RoboHelp can benefit you. www.ehelp.com/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
