Sondra Robinson's profile

Technical Writing & Documentation

Technical writing is more than simply "a then b", it's about effectively conveying complex information in an easy to understand way.

The patterns highlighted under the "Product Development" project needed to have instructions written which made assembly easy, regardless of the skill level of the constructionist. While each pattern developed obviously has its own set of instructions, below is a sample page for assembling a welted opening. For those not familiar with this, a welted pocket open is considered an advanced technique. Because it could be intimidating, a photo rich approach was chosen to help those who needed step-by-step references pictures in order to successfully complete the task.
For the training series created, which is highlighted under "Training Programs", printed reference documentation was provided to accompany the video. Because many times technical documents are referenced by those not overly familiar with the steps in the first place, I tend to go with a more image-rich approach. The goal is always to enable the user to successfully complete whatever is required just by using the document - no external reference or training needed. They are stand-alone guides intended to teach as well as serve as references once the process is learned.

In the case of the training documents, I created a template document that others could use to create their own group-specific docs which provided guidance for the creation of similarly comprehensive, easy-to-use-and-understand instructions for themselves.
I've also written Requirements and Functional Specifications (aka FuncSpecs) documentation for software development engineers, as well as QA Test Cases for software development quality assurance analysts. I've done competitive user flow analysis as well as competitive performance analysis documentation to product management teams. Unfortunately, there are no screen shots available of those corporate assets - even genericized as the images here are.
Technical Writing & Documentation
Published:

Technical Writing & Documentation

Published: