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 pretty new to the list, but have a question. Sort of a burr in the
saddle issue here at work.
Previously, programmers were writing doc and naming our installation
guides:
CABS R03V00 Mod 2
COGEN R04V00 Mod 1
New Customer
MVS Installation Guide
and
CABS R03V00 Mod 2
COGEN R04V00 Mod 1
Upgraded Customer
MVS Installation Guide
We were not installing MVS or upgrading MVS... we were installing and
upgrading our product: CABS/COGEN. I wanted to rename the books having a
banner running across the top of our covers indicating our latest software
release of our product (CABS/COGEN) and titled simply:
Installation Guide
(for MVS)
and
Software Upgrade Installation Guide
(for MVS)
The programmers are balking at this and telling me that other major
software houses do it the way they had it originally.
