Gordon Howard

Some Best Practices When Writing Help Documentation

If you are planning to create online help documentation and want to make sure you end up with one that is truly helpful, here are three best practices you can follow to make sure it is: Tailor it to users who have with varying skill sets and goals. Review, test, and update it for accuracy. […]

When Is Writing Not Enough?

Written by Michael Benavidez I’ve participated in a wide variety of technical writing courses, seminars, and presentations as a way to break into the industry. The speakers I’ve heard come from diverse backgrounds and experiences, but one common subject is that of change. Technical writer jobs today are not the same as they were ten or even […]

What is API Documentation?

By Peter Gruenbaum API documentation is a fast-growing segment of technical writing. API stands for Application Programming Interface, and it’s the way that software systems communicate with each other. What sets it apart from other types of documentation is that you are writing for an audience of software developers. APIs provide certain functionality, and software […]