“I worked with Robin at MorphoTrust USA when she was contracted to assist us with technical writing related to some intensive SOP documentation we were working on. Robin was quick to understand the complex UX and software development process details and produced high quality, well written documentation, within the structure we were seeking. She was very productive in her work. She also has a great sense of humor and was a lot of fun to work with.” ~~~ Nathan Lockwood, MorphoTrust USA
The photo above is a picture of Deer Island, Winthrop Ma. I’m sure when you first saw it you were wondering what it has to do with technical writing. And, it’s a great question.
The fact is technical writing includes documents for a variety of products and services. Did you know that Deer Island is known as the water treatment plant for Massachusetts? They take all the sewage and turn it into drinkable water. At the end of their tour they even offer you a sample. According to my Uncle Joe, it tastes good.
Let’s take a look at the different types of technical documents Deer Island could use:
- Standard Operating Procedures (SOPs)
- Safety Documents
- Operations and Maintenance Guides
How can I help? I have the ability to:
- Effectively understand and communicate technical and non-technical data easily. In fact, I write with my grandmother in mind for the non-technical audience.
- Work with skilled labor professionals and engineers to extract data for the purpose of documenting the design, manufacture, installation, and maintenance or products for both internal and external use
- Write requirements documents, supported by engineering for operations and maintenance manuals.
- Work with engineers and document procedures
I am one of those rare birds who feels good documentation is essential.
Having these documents provides a shorter learning curve and/or maintenance which ultimately saves the company both time and money.
This is especially important in software development for the next developer, engineer or QA person you hire. They need to be able to pick up the project and run with it. This means the ability to understand the logic and be able to follow a standard set of operating procedures. I know because I have worked the full Software Development Lifecycle (SDLC) and was a sought after Database Developer for many years creating and maintaining databases along with writing its documentation. Now I get calls to update various technical documents and give them one voice.
Samples available upon request.
To get a discussion started for your technical writing projects,