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.
We use a rather ad hoc document revision history approach, as we don't
have document management software or an audience of customers to
deliver the documentation to.
--- Mike <techmail_mike -at- yahoo -dot- com> wrote:
> Just wondering how many of you use a document revision
> history in your documents; and, if so, which edits do
> you place in the history? Major changes in content?
> Minor changes (a few words) in content? Changes in
> the template or other non-content items (page numbers,
> margins, and so on)?
If it's a few typos or minor art corrections for errors, depending on
how many, it might get a point raise (from 1.0 to 1.1). If there are a
lot of edits, definitely a point raise. I'll change the ordinal (say
from 1.4 to 2.0) for a phase 2 or a project or a major change to the
product being documented (major addition of features, that sort of
> Also, when do you decide when a new version of a
> document has been completed? In other words, at what
> point would you go from 3 to 3.1, or 3.1 to 3.1.5?
When it has to ship, it has been completed. If I have to give somebody
an updated copy, say because I couldn't get everything done in time
because of changes in the product at the last minute, they get a point
revision that suggests that additional information became available
after the fact.
The other time I change the version, either point or ordinal, is when I
think enough stuff has changed over time to warrant it.
I'll concede that it's a very ad hoc system, subject to my whims, but
in the absence of a need for anything better, It works for me, and I
don't have to obsess about it. Just slap something on there and move on
(unless, of course, you have clients or customers who expect something
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com or toll-free 877/278-2131.
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.