by Peter Gustafson | Nov 5, 2019 | API Technical Writer, Documentation, Featured |
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...
by Peter Gustafson | Nov 1, 2017 | API Technical Writer, Documentation |
If you’re a hiring manager or product owner, you’ll likely be able to answer this question without extreme brain power… What comes first: the API code documentation or your end-users? Pretty easy right? Wrong. I’ve seen many API interfaces...
by Peter Gustafson | Oct 18, 2017 | API Technical Writer, Technology |
1. API technical writer technology & UI/UX skills They possess experience in UI/UX design not only as an API technical writer but also understanding an exceptional user experience. Too few tech writers are diving into the deep end of user engagement. Although,...
by Peter Gustafson | Sep 26, 2017 | API Technical Writer, Technology |
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 | Aug 3, 2017 | API Technical Writer, Documentation |
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...
