Documentation: Software manuals
"ConflictManager Reference" for Wise Solutions, 2008
View sample topics. (PDF file, 341 KB) -- This sample consists of portions of a task-based chapter.
View the entire document. (PDF file, 362 KB)
Description: This sample shows the maturation of the ConflictManager documentation from version 3.0 through many releases.
Changes in the documentation:
- The page and template designs underwent several revisions to refine the appearance and accommodate changes in distribution methods.
After the acquisition by Altiris, the PDF and help templates were changed to meet the needs of both Wise Solutions and Altiris documentation. I collaborated with a colleague from Altiris on the template design. - In 2004, I edited the content to incorporates principles of the ABREVE writing methodology, which increases usability and facilitates localization. Some of the ABREVE principles are different from standard conventions (for example, using numerals for all numbers instead of just for 10 and greater). I reduced the word count by approximately 20 percent.
- After the acquisition by Symantec, I edited the content to incorporate some of the standards in the Symantec corporate style guide. A complete transition to the Symantec standards and content models was not feasible.
My role: Primary writer from inception through the release that this sample represents.
Tools used: Adobe FrameMaker, WebWorks Publisher, Visual SourceSafe.
Distribution: This document was distributed in PDF format with the ConflictManager software. The same information was delivered in HTML Help (CHM) format, which was accessible from within the software.
A printed version was not offered.
Publication date: February 2008.