FW: CVS For Documentation

[Lynn Perry <CLPerry -at- WALLDATA -dot- COM>]

We use PVCS, which sounds similar CVS. The problem with PVCS is that is
doesn't really handle some of the more subtle "document" features. PVCS
is great for text-based files and provides a huge amount of support for
managing change control, such as merging changes from differing versions
and tracking multiple revisions.  I have heard that some folks have
experienced problems with some kinds of documentation (such as
FrameMaker, PageMaker, or other layout types). I don't now remember the
problems, but it had to do with merging changes.  Any change merging
should be done in the tool used to create the doc, not using the
automated PVCS functionality.

There are no specific advantages for using PVCS for documentation, but
it's really not that much more difficult that using Visual SourceSafe
(except for having to learn an entirely new interface and tool and
having to use the DOS Command window, which can be intimidating to some
writers).

I can say that PVCS has saved techpubs bacon several times in the past
year, first when one of the writer's disk drive took a nosedive, and
then in helping us track when our (especially HTML) docs got corrupted.
It is very easy to check out older versions and do file compares to
determine where the changes occurred. That makes it a cinch to at least
locate the offending HTML (fixing it and understanding why the fix works
are subjects outside the scope of this e-mail).

Another advantage is being able to call on shared experience with the
developers. In my experience, anything that can help bring the techdocs
folks and the developers closer together is an major plus. And because
PVCS is so commonly used, I've found that my knowledge of the tool
itself has added to my credibility, which I find most useful.

Hope this helps.

C. Lynn Perry
clperry -at- walldata -dot- com
Opinions expressed are mine alone
Wall Data Incorporated, Seattle  WA
Some days it doesn't pay to gnaw through the straps

> -----Original Message-----
> From: Linda Castellani [SMTP:linda -at- GRIC -dot- COM]
> Sent: Wednesday, September 30, 1998 7:21 PM
> To:   TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject:      CVS For Documentation
>
> Hello All -
>
> We've been discussing using CVS to store and track our documents,
> including
> manuals and training materials.  Our developers use it, and the
> current
> thought is that we would use it to store final documents with the
> source
> code, as well as check our documents in as we write them.
>
> I'm having a little trouble understanding the benefit of using this,
> and I
> wondering if any of you have experience with using this particular
> product.
>  (I did attempt to search the archives, but it told me to come back
> later.)
>  If you do have experience with using CVS for documentation (not just
> opinions about it %^) ), I would greatly appreciate hearing about the
> benefits as well as any caveats, so I can be armed with this
> information at
> our meeting next week.
>
> My thanks in advance!
>
> Linda
>
> ==========================
> Obligatory quote:
>
> "I'm not always under stress.  Sometimes I'm just a carrier."
>                                         - my boyfriend, Mike
>
> Linda Castellani
> Technical Writer
> GRIC Communications, Inc.
> 1421 McCarthy Blvd.
> Milpitas, CA   95035
>
> 408.965.1169
> 408.955.1968 - fax
>
> linda -at- gric -dot- com
> <http://www.gric.com>
>
>
> ======================================================================
> =====
> Send commands to listserv -at- listserv -dot- okstate -dot- edu (e.g., SIGNOFF
> TECHWR-L)
>


 From ??? -at- ??? Sun Jan 00 00:00:00 0000=