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.
Subject:Maintaining a Readme From:Gerry Bourguignon <GBourgui -at- LAVASYS -dot- COM> Date:Wed, 9 Jun 1999 11:26:16 -0400
How do you deal with last minute information that needs to go into a Readme
file?
We use the InstallShield product which provides the user with the option of
viewing the Readme at the end of the installation so, as far as I know, the
Readme must be included in the build. Therefore, if the Readme changes
(which it often does), a new build must be generated (and subsequently
tested). Is there a way around this?
On a similar note, what should the Readme contain? The Readme I am
currently maintaining contains information that should perhaps go elsewhere.
For example, it includes installation/upgrade instructions along with
platforms and software supported, known issues, etc.
