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.
Re: Automating docs compilation in the software build process
Subject:Re: Automating docs compilation in the software build process From:dmbrown -at- brown-inc -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 16 May 2003 13:44:11 -0700
David Handy wrote:
>
> Has anyone had any experience doing this? Are there major snags?
Years ago in a former situation, all we delivered were WinHelp files, and we used this process. Source files in VSS were checked out, compiled, and included in the resulting installer...all done automatically by the build process, which did exactly the same thing for the program itself.
It worked great, because--just as the developers did with the source code--we had already built and tested the docs prior to the build.
The advantage--especially with nightly development builds--was that we didn't have to take time to recompile every day before going home, but the latest help was always available with the new build every morning.
Snags didn't arise *because* we tested the heck out it.
By the way, I don't do the same thing with PDF, nowadays, because there are a couple of customizations to the finished PDF that have to be done manually.
HTML Indexer 4 is still the easiest way to create and maintain indexes
for web sites, intranets, HTML Help, JavaHelp, and other HTML documents.
HTML Indexer 4 includes fully integrated cross-references, target frames
and windows, multiple-file output, "one-step accept" of default entries,
and more!
---
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.