[Ellen Theisen Communications] [About My Product Documentation]

[Services - Home][Product Documentation - Selected][Illustrations][VBA Macros][Business Communications][Projects][Background] I create manuals that people like to open ... even the second time. Prepared with unbending concern for accuracy and tender concern for users, my manuals help users find the information they need.

Starting with any type of input, from sketchy notes to interviews with knowledgeable personnel, I build any type of technical document.
I manage and implement all aspects of the documentation:

     Researching details
     Organizing the material
     Designing the layout
     Writing the text
     Creating illustrations
     Building online Help
     Developing the index

I also track and report all product problems I encounter and offer usability recommendations. In most cases, I manage the production of the finished document, in whatever form my client needs.
User documents such as installation manuals, operation manuals, tutorials, and reference guides.

Sample: One of my fairly large projects, this 450-page manual provides all the information and instructions needed by the system administrator of a software application that helps specialty veterinarians manage their practices.

[Manual 1 Picture] The manual gives details for managing inventory, setting up the appointment scheduler, creating and maintaining macros, creating custom reports, and more. The table of contents and comprehensive index give users immediate access to every feature and function provided by the program.

Manual cover reproduced with permission from
Animal Intelligence Software, Inc.

Technical documents such as programming guides and design specifications.

Sample: This 60-page manual, which I wrote for software developers, explains all the details of using a device driver for a frame-grabber board. The driver supports and manages the acquisition of infrared image data from a thermal camera and the subsequent transfer of that data to a set of software tools for analyzing the temperatures in the image.

[Manual 2 Picture] The manual explains the operational concepts of the driver, provides tutorial-like instructions leading the reader through the process of using the driver, and includes a detailed reference to the driver’s properties and methods.

Manual cover reproduced with permission from
FSI Automation.

Marketing materials such as data sheets, product descriptions, and brochures.

Sample: This is the front page of a two-page marketing data sheet. It announces the new version of a set of ActiveX controls that provide programmers with the tools they need to acquire and analyze images of all types.

[Data Sheet Picture] I also wrote the 1450-page programmer’s reference guide for the product, published it in three volumes, and converted it to Windows online help with extensive internal jumps and context-sensitive links to all of the 515 properties, methods, and events. Since then, I have converted the manual to an Acrobat Reader document, with bookmarks and index links.

Data sheet reproduced with permission from
FSI Automation.

Contact me

Copyright © 2002-2009 Ellen Theisen Communications.
All illustrations by Ellen Theisen.