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.
> I'm looking for advice on the best way to handle documentation revisions. I'm
> working on a software development project. We currently release updates every
> month or so.
Been there. Done that. Gave up trying. With paper that is. We also
deal with monthly to bi-monthly updates. Trying to inventory everything,
keep manuals/release notes up to date, and getting a decent set of
documentation out to customers was a nightmare. I essentially decided
to put any and all volitile information online, and reduce our manuals
to the bare essentials -- getting started, installation, basic procedures.
Overall, this should cut costs, and allow us to keep the information
more correct. This is only because we bypass any inventory problems.
And, we can control which help file gets installed with the product,
eliminating the other problem: users see one thing on screen and another
I'll let you all know just how big of a success/failure this turns out to
glen accardo glen -at- softint -dot- com
Software Interfaces, Inc. (713) 492-0707 x122
Houston, TX 77084