Re: Version number question

Subject: Re: Version number question
From: Julie Stickler <jstickler -at- gmail -dot- com>
To: Technical Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 19 Dec 2013 09:59:17 -0500

I'm assuming you have two version numbers on the doc? The product version
and the doc version? For example, WidgetInstallationGuide_4.0_v2.pdf?

My choice would be to wait for the next product release (when presumably
your doc version goes back to 1.0) and perform the split then. Then you
could have

WidgetInstallationGuide_4.1_v1.pdf

WidgetTechnicalOverview_4.1_v1.pdf

Of course, this depends on how often you have product releases.


On Wed, Dec 18, 2013 at 8:31 PM, Jim Witkin <jameswitkin -at- gmail -dot- com> wrote:

> I'm working on a manual that contains two primary sections: a technical
> description of the product and an installation section. The manual has
> gotten quite long and we've observed that the audience for each section is
> somewhat different. For example, installers don't need the 80 pages of
> technical description to install the product. Our plan is to split the
> manual in half and move forward with two manuals each with its own revision
> track. The current version number for the manual is v2.4. Question: When I
> split the manual should I start the version numbering at 1.0 for each of
> the two manuals? Or should the technical description manual maintain the
> previous numbering track and the installation manual start with new version
> numbering? Or vice versa? Or should both new manuals start with the
> previous manual's numbers and increment from there? Thx, Jim
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for
> authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as jstickler -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>



--
Julie Stickler
http://heratech.wordpress.com/
Blogging about Agile and technical writing


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Version number question: From: Jim Witkin

Previous by Author: Just out of curiosity - ratio of TW to training? or Marketing?
Next by Author: Re: On the value of glossaries containing terms the audience should already know
Previous by Thread: Version number question
Next by Thread: Re: Version number question


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

Sponsored Ads


Sponsored Ads