What’s your prescription for new API docs?

API Docs Deader Than Disco

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...

API Technical Writer – Hire For These Skills Or Else…

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....

Simple API Docs: Lessons from Battery Daddy

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....

Technical Documentation Generators: The Good, The Bad & Ugly

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...

5 Questions To Ask Your Technical Writer Candidates

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.

800 lb. Gorilla Gaps Between Programmers and Tech Writers

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...

When Are PDFs a Smart Output Option?

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.

API technical writers are game changers helping users. Happy users means more revenue. I love that…

Dynamic API documentation interfaces need to be robust. Does yours need a full analysis and…

 

Documentation writing is a passion of mine. Your project deserves logic and planning. Then speedy…

 

Too many companies get stuck with sloppy authoring tools. Or worse, writers who rely on outdatedā€¦