Technical Writing

 

Overview

Technical writing is the process of retrieving technical information from one source and formulating it for communication to another audience (usually a wider and less technically sophisticated audience).

 

Elements of Technical Writing

Technical writing generally includes:

·        research (often consultation of subject matter experts combined with some first-hand experience with the technology)

·        user needs analysis

·        organization of information for efficient retrieval

·        careful revision based on reviews by subject matter experts.  

Technical writing requires project management, document planning, and technical editing skills, frequently involves collaboration with technical illustrators, and often must be done with translation in mind.

I use Information Mapping® to help organize and convey information for maximum efficiency and shortest retrieval times.

 

How I Can Help

I can consult with your subject matter experts and conduct other research as necessary to develop a document plan. Then I can implement the plan, including the creation of any technical illustrations that might be necessary.

By performing technical writing functions for your company, I can free your technical experts from a task that they may not enjoy and do not do as well or efficiently as a professional technical communicator.

 

My Qualifications

I have done technical writing for more than 15 years in a variety of settings, including academic, nonprofit, and private industrial. My technical writing has included diverse subject areas, including electronics and software for science education, medicine, and biotechnology.  I have written for diverse audiences, including academic, medical professional, the FDA, and high school and middle school science teachers and students.

I have been a member of the Society for Technical Communication since 1996, having served on the Board of Directors of the Sacramento Chapter in a number of capacities, including President, for 6 of those years. I have been a member of the American Medical Writers Association since 1986 and am currently the Treasurer of the Northern California Chapter.

 

More Information

JoAnn T. Hackos and Janice C. Redish.  User and Task Analysis for Interface Design. John Wiley & Sons, Inc. New York. 1998. 488 pp.

Society for Technical Communication

American Medical Writers Association

Information Mapping