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.
Re: Include Service Pack Release Notes in Online Help?
Subject:Re: Include Service Pack Release Notes in Online Help? From:dmbrown -at- brown-inc -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 28 Jul 2005 12:17:57 -0700
I've taken to building up release notes, cumulatively, over the life of a
major revision. So the 7.2.1 release notes would have separate sections
for what was added or fixed in 7.2.1, 7.2, 7.1.3, 7.1.2, 7.1, 7.0.1, and
7.0, for example. Known issues are collected in a single section whose
content "rolls" from one release to the next, with newly added issues at
the top of the list and clearly flagged to get your attention.
Except for the known issues (which roll forward until resolved), I start
with a clean slate at each major release. In my example, then, the 8.0
release notes would have a section on what was added or fixed in that
release alone.
The 7.2.1 release notes would still be available to customers, though...at
least until I felt sure I'd moved all the useful information into some
other document (help, user's guide, white paper, whatever was appropriate).
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -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.