Do you know who's reading your Docs?
summary
Argues that API docs must target multiple real audiences and gives concrete cases: at Symantec a new SOAP API plus site interviews still stumble on authorization code flow for on‑prem installs forcing heavy custom support; at Capital One the developer portal pairs endpoints + use cases so engineers and PMs both get what they need; at Stripe docs accompany tiny integration options like hosted pages that work with one or two lines of code, leaving a remaining tension between brevity and deep technical detail.
AI-written summary · about
chapters (9)
- 0:00Introduction
- 3:00About Jennifer
- 5:40Developers vs end users
- 6:22Nonengineering roles
- 11:28Three stories
- 12:50Semantic
- 18:25Case study Capital One
- 20:51Stripe
- 22:45Documentation
related talks
22mBeyond the Spec: Making OpenAPI More Human
30mSo You Need to Document an API?
27mGetting developers hooked on your API
16mWriting for what Matters
27mAI-Enhanced API Documentation [...]
24mDocs for Developers: How to start when everything is hard
38mThe Secret to Brewing up a Good API
35mOpenAPI for Documentarians