Great Documentation Defined

Great documentation answers the common questions users have, and some less common questions as well. The goal of good technical writing is to give readers familiarity with your product, i.e. a deep understanding and level of comfort with the equipment so they can start using it properly and its full capability.

The more complex and technical the product, the more this is true. The more sophisticated the audience, the more they will expect, therefore the more detail required in the manual. Details in this type of documentation must be both precise and accurate. I excel at delivering this type of detail-oriented technical writing.

The manual must be concise. Would you rather read a 387 page manual, or a 450 page manual covering the same material in a more verbose style? It is easier to write a long manual than a short one covering the same material, but the time spent tightening language improves the manual, resulting in crisp, clear, professional results.

Producing great documentation requires deep familiarity with the product, an understanding of the clients’ needs, and attention to detail.

I excel at rapidly gaining insight and familiarity with the product. I specialize in gathering detailed information with a minimum of load on technical staff. When I ask questions, they are good, specific questions which only the product designers can answer. By being specific I make it quick and easy for engineers and designers to answer my questions.

This makes the whole documentation process painless for you and your staff while producing excellent results.