Shuffle ball change: Sashay your way to clearer API documentation¶
Sketchnote
Description
Learn how to tap into your audacious self to improve API documentation at your organization. In this talk, I’ll compare processes across a few different companies and teams for authoring, editing, and maintaining various types of API reference documentation.
We’ll touch on these topics and more:
- Discovering unexpected benefits of API-specific knowledge
- Levering bulk edits for when a reference needs an entire overhaul
- Balancing ownership of an OpenAPI spec or source comments
- Chasing developer commits
- Establishing API reference writing guidelines for developers
If you’ve ever found yourself wondering how and where to start making improvements to API reference docs, this talk may inspire you to heel/toe your way into the spotlight.
- Conference: Write the Docs Portland
- Year: 2021
