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:Software version numbers From:kendal stitzel <kensti -at- KENSTI -dot- AUTO-TROL -dot- COM> Date:Mon, 22 Nov 1993 10:42:07 MST
I work for a company that makes a variety of UNIX-based software products.
[insert marketing brochure here]
Lately, some of our software developers have been agitating to get us to
include the software version numbers with our manuals. In the past this
has been handled by sending out a letter with the software and (sometimes)
update pages for the manual.
Obviously, it`s nice for the user to have the most recent software version
number printed on the manual.
The problem for us writers is that the company sends out a LOT of different
updates and most of these do not require update pages to the documentation.
We're already swamped and would rather not have to update zillions of title
pages. (We use FrameMaker and Frame doesn't send out update pages; we find
this quite annoying sometimes, having to dig up the release notes to make
sure something has or hasn't changed.)
But enough whining. How have some of y'all dealt with this issue? Do you
send out updated title pages with software version changes? Do you trust
your users to track these changes with Release Notes? Do you not have this
problem at all and prefer to discuss sports or holiday plans?
Ken Stitzel (not that other guy)
(kensti -at- Auto-trol -dot- com if you prefer e-mail)