What’s your prescription for new API docs?

by Peter Gustafson | November 5, 2019 | API Technical Writer | 0 Comments

After nearly a decade writing API documentation for companies of all sizes, I have a handful of confessions to make. Exported API reference documentation went out with disco. Okay, maybe that's a stretch. But it's spot-on when it comes to the struggles thousands of...

by Peter Gustafson | October 18, 2017 | API Documentation Format | 0 Comments

1. API technical writer technology & UI/UX skills They possess experience in UI/UX design. As an API technical writer, they thrive helping build exceptional user experiences. Can they edit or manage the publishing of API reference documentation? I hope so....

by Peter Gustafson | January 16, 2021 | API Doc Guides | 0 Comments

Never before in history have so many APIs been firing on all cylinders than now. The software industry is on a fast train to more jobs, projects and products. I dusted off some of my favorite gems for this post. Ones I have borrowed and integrated into my projects....

by Peter Gustafson | June 5, 2014 | Technical Documentation | 0 Comments

Managing documentation comes in a plethora of frameworks. Unfortunately, many technical writers resort to the softer side of their skill sets (i.e. MS Word, MadCap Flare, FrameMaker). Ideally, choosing a tool should be tethered to the intended output type. When you...

by Peter Gustafson | March 8, 2016 | Hiring Technical Writers | 0 Comments

Interviewing technical writers isn’t easy. When creative approaches and skill sets are a hot commodity, you’re best to find out about their learning ability.

by Peter Gustafson | August 3, 2017 | APi Developer Docs, API Doc Guides | 0 Comments

To be honest, this is a post I've wanted to write for years. However, because of my commitment to clients and projects, I've restrained myself from spouting off about the 800 lb. gorilla. This sneaky monster-like breakdown is breeding throughout many software...

by Peter Gustafson | June 9, 2015 | API Technical Writer, Documentation | 0 Comments

If I had a nickel for every time a project manager told me to just, “Send it to everyone as a PDF,” I’d be living in a tropical paradise working on my tan.