documentation Archives

se-stackoverflow June 21, 2022

Experts from Stripe and Waymo explain how to craft great documentation (Ep. 455)

We chat with Jared Bhatti and Zachary Sarah Corleissen, two technical writers with deep experience at major tech companies and open source projects, about their approach to documentation and the new book they helped co-author, Doc For Devs.

Eira May Content Writer

code-for-a-living May 2, 2022

Building a community of open-source documentation contributors

When your open-source project starts getting contributors, it can feel great! But as a project grows, contributors can neglect to document everything.

Jared Bhatti and Zachary Sarah Corleissen

code-for-a-living April 25, 2022

Empathy for the Dev: Avoiding common pitfalls when communicating with developers

All too often, developers go deep on the wrong things, when writing documentation. A little bit of empathy can get your docs back on track.

Heidi Waterhouse

code-for-a-living December 21, 2021

“This should never happen. If it does, call the developers.”

If there is one thing developers like less than writing documentation, it's responding to unnecessary escalations.

Thomas A. Limoncelli Site Reliability Engineering Manager

code-for-a-living September 28, 2020

How Stackers ditched the wiki and migrated to Articles

In an effort to rethink how documentation works, we recently introduced Articles, longer-form prose that can sit side by side with shorter Q&A.

Ben Popper and Medi Madelen Gwosdz

code-for-a-living July 13, 2020

Tales from documentation: Write for your clueless users

When you're documenting anything technical, it's easy to forget what it's like being ignorant of how the software works, especially if you built the thing.

Ryan Donovan

posts by author or