Zen And The Art Of Automanually Creating API Documentation - An Inquiry Into Process
summary
Claims an automanual workflow: start with manual documentation to learn edge cases, generate OpenAPI spec files from code, add linting and scripts, then automate CI/CD posting to ReadMe/Swagger/Apiary. Teams build a central field‑description store and alerts, iterate service by service, and measure outcomes by fewer support tickets and fewer late‑night fixes. Concrete artifacts include generated OAS files, automation scripts, and a staging pipeline; the process reduces brittleness and uncovers requirement mismatches early.
AI-written summary · about
chapters (7)
- 0:00Start
- 3:17What are we trying to fix?
- 9:47How could we make things better?
- 11:35Incremental approach - what does it solve?
- 13:24What does an incremental approach look like?
- 20:48Position versus Interest
- 22:29The Five Whys
related talks
42mAutomating Empathy: Test Your Docs with Swagger and Apivore
26mA sensible API Document Management guide
35mOpenAPI for Documentarians
22mBeyond the Spec: Making OpenAPI More Human
19mAutomate your API to perfection
21mLet there be docs!
27mGetting developers hooked on your API
24mBuilding an Accessible API Spec with Traditional Engineering Teams