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: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.
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-