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.
You could keep the Doc. Version number, but have a different date - e.g.
Rel. 1.0 05/06, Rel 1.0, nn/06, etc, for similar updates to the doc.
Also include a revision history page in the doc if you haven't already,
so the reader can tell that the product hasn't changed, just the
information about it contained in the doc.
Ron
-----Original Message-----
From: techwr-l-bounces+rhearn=cucbc -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+rhearn=cucbc -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of obair81 -at- comcast -dot- net
Sent: Wednesday, May 03, 2006 10:13 AM
To: Lisa Roth
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: doc release numbering
The dept is fairly new (just myself now), and there is simply no method
now in place. There was one writer before me, but she did nothing along
these lines.
I am here just 4 months now, so I am trying to set some standards.
I like your ideas below, but I am just dealing with hardware (for this
product, anyway).
Is it kosher to put something like Documentation Version 1.0, and so on,
on the title page (where I used to put the software version, when I
wrote about just software)? Again, here the hardware is not changing.
Paul
-------------- Original message ----------------------
From: Lisa Roth <roth -dot- lisa -at- jimmy -dot- harvard -dot- edu>
> I think the biggest issue that would help shape your answer is how do
> you number docs now?
>
> Our system, for example, is composed of a dept code, a sequential
number
> that represents nothing more than the fact that it's the nth document
> produced *ever* for that department, followed by "v1, v2," etc.
>
> So our docs simply get ticked up in the version # and a version note
is
> added. In a circumstance like your the version note might read "For
> software version 1.2. Updated to correct instructions in section X."
>
> Then when a truly new software version came out, the note might read:
> "For software version 2.0. Updated to document new software modules
and
> features. Updated instructions for workflows in the new version."
>
> or something vaguely to that effect.
>
>
> I know other places do docs similarly to the software numbering where
v1
> is the first doc for a s/w version, but minor updates to the doc *in
> between* new software versions are 1.1, 1.2, etc.
>
>
>
> obair81 -at- comcast -dot- net wrote:
> > Due to things beyond my control, we (I) had to turn out a doc set
last week
> for a new hardware product, and next I will have to turn out another
(updated)
> doc set for the same product. The product name/number have not
changed.
> >
> > Is there any sort of standard for numbering versions of the docs, if
the
> product is not changing?
> >
> > I have not dealt with this question before.
> >
> > The voice(s) of experience would be welcome.
> >
> > Thanks.
> >
> > best,
> > Paul
> > ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> >
> > 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
> >
> > Doc-To-Help includes a one-click RoboHelp project converter. It's
that easy.
> Watch the demo at http://www.DocToHelp.com/TechwrlList
> >
> > ---
> > You are currently subscribed to TECHWR-L as
roth -dot- lisa -at- jimmy -dot- harvard -dot- edu -dot-
> >
> > To unsubscribe send a blank email to
> > techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> > or visit
> http://lists.techwr-l.com/mailman/options/techwr-l/roth.lisa%40jimmy.har
vard.edu
> >
> >
> > To subscribe, send a blank email to techwr-l-join -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.
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
