Standards and procedures
"Documentation Procedures" for Wise Solutions
View sample topics. (PDF file, 1,464 KB) -- The sample consists of several topics that describe our strategy for producing multiple deliverables from a single source.
View the entire document. (PDF file, 1,516 KB)
Purpose: To document the standards and procedures to use when producing documentation for Wise Solutions products.
Audience: Members of the Wise Solutions technical publications team and contract writers.
My role: Writer, editor, manager.
This document was a collaborative effort. Although I wrote much of the content and managed the whole, all members of the team had input into the standards and contributed to the content. For example, one person wrote the chapter on indexing, and the person who was responsible for building help wrote the chapter on creating help with WebWorks.
Tools used: Adobe FrameMaker, Adobe Acrobat Standard.
Corporate style: This document follows the format, structure, and style guidelines that were developed by the Wise Solutions technical publications team.
Although "Documentation Procedures" was meant for internal use, I tried to keep it up to our standards for external documentation. However, as a work in progress, it contained occasional author's notes and incomplete sections that we would not allow in user-facing documentation.
Distribution: This document was produced in PDF format and posted on a shared network location.
Publication date: This document was updated and released as needed. The sample is dated January 21, 2005.