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:Re: Version Numbers for Help Files From:Bill Bledsoe <bill -at- ENVISION -dot- COM> Date:Thu, 4 Apr 1996 10:22:03 -0600
List,
Let me chime in here. We always consider help separate from the
application. In fact, we treat help like a separate application all
together. (Its own QA, CM and then Rollout). I have found many times that
we have had to release just an updated Help File for a variety of reasons.
Bottom line here is this: If your help documentation is viewed as an
integral part of the whole package (software, packaging,
documentation=product) then when any part of that product needs updating,
it should happen. Tying that version number to the software release number
really puts a cramp in that way of thinking.
just my $.02 (US)
------------------------------------------------------------------------
-----
Bill Bledsoe "Junk moved on line is still junk. You can
Documentation Specialist bet that if they didn't read the printed
Envision version, they won't read the online version
bill -at- envision -dot- com either." Dr. Conrad Gottfredson, online
or documentation guru-guy
intlidocs -at- mo -dot- net
------------------------------------------------------------------------
-----
----------
From: Richard Mateosian[SMTP:srm -at- C2 -dot- ORG]
Sent: Thursday, April 04, 1996 9:43 AM
To: Multiple recipients of list TECHWR-L
Subject: Re: Version Numbers for Help Files
>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 seems reasonable.
I don't find that approach unreasonable. I think you should regard the help
file as part of the program. ...RM
Richard Mateosian Freelance Technical Writer
srm -at- c2 -dot- org Copyright 1996 Review Editor, IEEE Micro http://www.c2.org/~srm/ All rights reserved President, Berkeley STC
