Version Numbers for Help Files

Subject: Version Numbers for Help Files
From: Keith Soltys <ksoltys -at- DJTTD -dot- COM>
Date: Thu, 4 Apr 1996 09:09:40 +0000

Our QA Department has requested that we put version numbers in our
help files, to help them track updates or changes to the online help.
There are a couple of issues here, first whether we use a version
number at all; second whether we use the same version number as the
software.

I think we can rule out using the same version number as the
software. That would mean that we could have to recompile the help
file every time a minor change was made to the program, and a minor
change to our help file could force development to recompile the
software. Neither alternative seems reasonable.

As far as a version number for the help, most help files that I've
looked at don't include one. It should be easy enough to track
versions by file date/time and size, assuming this changes when you
release a new version, and you keep track of the information.

I'm curious to know how other people are handling this.

Regards,
Keith




Keith Soltys http://www.io.org/~ksoltys
Technical Writer ksoltys -at- djttd -dot- com
Technical Development ksoltys -at- io -dot- org
Dow Jones Telerate Canada Inc.


Previous by Author: Contract Opening in Atlanta, GA
Next by Author: GMT or Universal Time?
Previous by Thread: Re: Information about page design
Next by Thread: Re: Version Numbers for Help Files


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads