Christopher R. Smith - Technical Writing
 

Writing Sample - Bocada Centralized Manager Installation Guide

When you write a user guide you are teaching a class. Your users are your students and they can be an inattentive bunch. The aim here is simple: the best user manual or guide is one that gets read. It's not your job to entertain your readers, but don't bore them unnecessarily. Keep the sections short and use descriptive headers for quick reference.



Here is an exerpt from a 33-page installation guide I wrote for the Bocada Centralized Manager product.


Home

Technical Writing

Online Help

Training and Education

Web Marketing

Software Specs

Magazine Articles

My Resume

Contact Me