Re: Automating docs compilation in the software build process

Subject: Re: Automating docs compilation in the software build process
From: Doc <doc -at- vertext -dot- org>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 16 May 2003 12:33:25 -0400

On Fri, 16 May 2003 17:14:18 +0100, David Handy
<david -dot- handy -at- automsoft -dot- com> wrote:

>Has anyone had any experience doing this? Are there major snags?

Do it both ways. There are a couple of reasons for this.

1) You will need to compile and generate final format so you can check
to make sure that everything works properly.

2) If their automated compile fails, you will still have the completed
docs ready to go.

A few years ago we had a disaster when it turned out that the
developers had not read the VSS docs carefully (quelle surprise). They
didn't realize that every now and then you actually had to optimize
the database and move older material out.

We had a massive crash. Three weeks of code went up in smoke just
before the product went gold. The doc was maintained in a separate
database, but VSS played no favorites and ours was corrupted beyond

But, since we compiled our own docs for proofing and QA, we got to sit
back a bit and enjoy watching the programmers try to catch back up to
the documentation.

The VerText Company
South Hamilton, MA

Our choicest plans have fallen through
our airiest castles tumbled over
because of lines we neatly drew
and later neatly stumbled over.
-- Piet Hein


Robohelp X3, from eHelp, lets you quickly and easily create
professional Help systems for all your Windows and Web-based
applications, including Net.

Order RoboHelp X3 in May and receive a $100 mail-in rebate, PLUS
free RoboScreenCapture and WebHelp Merge Module.

Order RoboHelp today:

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 for more resources and info.

Previous by Author: Re: Another terminology question
Next by Author: Re: Title Help.
Previous by Thread: Re: Automating docs compilation in the software build process
Next by Thread: RE: Automating docs compilation in the software build process

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

Sponsored Ads