I wrote this style guide over the course of four months. I customized it to the IT company I was working for and that is why you’ll find some IT-specific elements in there. I didn’t just customize it to address the IT industry, however; it was also tailored to the unique communication problems of that company. I spent weeks researching company documents, weeding out mistakes, and developing a general sense of the kinds of communication challenges the technical staff were facing. There was a pattern, indeed. I was happy to tackle this pattern in a style guide that was meant to standardize company communication.
Here, you’ll find the full table of contents, along with a few excerpts from the 55-page document.
This is a sample of my work. Enjoy!
User manual excerpt
I must admit, working at NASA as a technical writer would be an interesting experience indeed!
I came across this handbook for technical writers on NASA’s online archive here.
Also interesting, is an old compilation of papers on the technical writing profession on NASA’s website. I enjoyed skimming through this document, particularly the paper titled “How do Technical and Non-Technical Personnel Communicate?” by June Ferrill. I like the tips that she presents in her paper, on how to make for a more productive working relationship between subject-matter experts (ie, engineers) and technical writers.
“Elements of Understanding Technical Material” by June Ferrill
(screenshot taken from here)
- Technical Writers & Editors
- Globalization & Localization Specialists
- Usability & Human Factors Professionals
- Web Designers & Developers
- Teachers & Researchers of Technical Communication
- Trainers and E-Learning Developers
This list was obtained from the Society for Technical Communication at http://stc.org/about-stc/the-profession-all-about-technical-communication/defining-tc
“What all technical communicators have in common is a user-centered approach to providing the right information, in the right way, at the right time to make someone’s life easier and more productive.” —STC
This blog aims to provide insight on technical communication as a profession and how it is essential across disciplines and fields.
Feel free to browse around!