Software Documentation

Hardware Documentation

The RF Plan User Guide is targeted at an audience which includes System Administrators and managers who are responsible for planning corporate wireless networks.
I was responsible for planning and developing this document. It was developed over a period of approximately 90 days, working with the software, developers, Product Managers, and QA.
This document was produced using FrameMaker and Photoshop for preparing screenshots. It consists of 36 pages and more than 20 images.
The RF Plan User Guide is delivered in both traditional print and PDF formats.
The Wyse Winterm 3000 Windows-based Terminal Administrators Guide is targeted for the IT Administrator audience.
IIn addition to being the Technical Publications Manager I was also a contributor. In the case of this document, I revised a similar document to create this one. The finished document was published in less than 60 days working with developers, QA, and a Production Editor.
The document was produced using FrameMaker and delivered in PDF and HTML format. It consists of 352 pages and more than 100 figures and photographs.
The audience for this document cosists of IT Administrators and Network Engineers.
I contributed approximately 90% of the material in this document. The material in the document was developed by direct experimentation with the device, interviewing developers and QA personnel.
The document was prepared using FrameMaker and delivered in traditional print and PDF formats.
The API Guide is targeted at the developer audience.
This limited sample shows an example of eight APIs related to "the Company's" customer support function.
The entire set consists of more than 300 APIs of similar complexity.
The Upgrade Instalation Manual is a step-wise guide intended for an IT Technician audience.
I was responsible for planning and producing this document. It was developed over a period of approximately two weeks working with developers and QA.
The document was produced using FrameMaker and Photoshop. It consists of 24 pages and 6 images.
The document was delivered in PDF format.
The Facilities Planning & Installation Guide is intended for the Facilities Engineer and Equipment Maintenance audience.
NOTE: The sample document is an excerpted form.
I was the sole contributor responsible for the development of the guide. The document was developed over a period of approximately 30 days working with Mechanical, Electrical, and Process Engineers.
The complete document consists of approximately 30 pages and includes a large number of line drawings.
The document was delivered in traditional paper format.
The Illustrated Parts Guide is intended for an audience of Maintenance Engineers and Technicians.
I was responsible for the planning and development of the document as the sole contributor. The document was developed over a period of approximately six months, working with Bills of Material, and Mechanical Engineers.
The document was produced using Ventura Publisher and Corel Draw. It consists of approximately 150 pages.
The document was delivered in traditional print format.