Re: Revision or Version

Subject: Re: Revision or Version
From: Buck Buchanan <buck -dot- buchanan -at- CITICORP -dot- COM>
Date: Wed, 13 Aug 1997 13:20:51 -0700

> We tend to use "Revision" when we're changing content but not
> substance. In other words, the program hasn't changed substantially,
> but what is said about it has. Or there have been minor changes to the
> program because of bug fixes.
>
> We tend to use "Version" when there has been a major change to the
> substance.


My dear boss, whose training for documentation was writing/reading haiku
in a 60's coffee house, plus several years as an Antenna Installer on
M/wave towers, has installed a "REVISION HISTORY" in all of our DRAFT
manuals.

The manual which I just finished had "a" through "h" revisions.
Revision "g" was where she RAN SPELL CHECK. Changed Hewlett Packard to
Hewlitt Packard, however.

Following "h" she released the document without the DRAFT letter
revisions and without the REVISION HISTORY page.

And three months ago I thought this place was so great. I suppose I'm
just flaky. Friday's my last day, thank god. I don't have to work
again until January (Social Security limitation).
--
Buck Buchanan
Software Documentation
Citicorp Technology Center
Westlake, Texas
Speaking for me, not for them!

buck -dot- buchanan -at- citicorp -dot- com
Home: writer -at- wf -dot- net

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Re: gender sensitivity and pronoun use
Next by Author: Re: Choosing a menu option
Previous by Thread: Re: Revision or Version
Next by Thread: Re: gender sensitivity and pronoun use


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


Sponsored Ads