Stephanie Blotner
A primer on documentation content strategy
Tips to help engineering teams produce high-quality documentation—with or without the support of designated technical writers.
This issue explores documentation as an approachable, essential, and innovative part of engineering culture.
Dave Nunez
Why it’s worth it to invest in internal docs
Good internal documentation leads to more stable and innovative development, and a better experience for users and developers alike. Here’s a look at some best practices, and how engineering orgs can make documentation a part of their culture.
Aaron Suggs
What a deploy bot taught us about documentation
How Glossier used a reader-centric approach to simplify their development team’s code deployment process and improve velocity.
Sweta Ackerman
Post-mortems to the rescue
Effective post-mortem documentation can improve the incident response process—and save on-call developers lost sleep.
Poornima Apte
Documentation in an agile world
The long and short of the perks and pitfalls of using bug-tracking systems as central repositories for internal documentation.
Chris Stokel-Walker
Let’s talk about docs
As documentation evolves beyond the written word, what will its future look like? Three expert tech writers and communicators share their takes on what was, what is, and what they think will be.
Alvaro Videla
Notes on the synthesis of labyrinths
Solving problems in software development is not unlike finding your way out of a maze. Consider how documentation might reflect the twists and turns you faced along way—not just the end result.
James Turnbull
Documentation as a gateway to open source
If you’re interested in getting involved with open source, contributing to documentation is a good—and helpful—place to start.Ines Montani
The process: Transforming spaCy’s docs
Making your documentation work for users with vastly different needs is a challenge. Here’s how spaCy, an open-source library for natural language processing, did it.Glenn Fleishman
“How-to” build a civilization
A look at historical technical documentation—from guidelines for building Noah’s ark to using early computers like the BINAC—and the parallels we see in the docs of today.
David J. Lumb
Inside the complex world of life-saving software
Nuclear power plants. Medical devices. Airplanes. Self-driving cars. Developing software for safety-critical projects takes documentation to the next level.
