Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Building Better API Documentation

Avatar for Daniel Beck Daniel Beck
October 22, 2011
Programming
150
1

Building Better API Documentation

Why doc generation is bad for you and what to do instead.

Avatar for Daniel Beck

Daniel Beck

October 22, 2011

Other Decks in Programming

See All in Programming
LLMによるContent Moderationの本番運用の裏側と品質担保への挑戦
Avatar for suikabar suikabar
3
780
トークンをケチるな、設計しろ：GitHub Copilotを賢く使うコンテキスト戦略
Avatar for Ochtum ochtum
0
170
Developing with AI Agents — Codex, Claude Code & Cowork Practical Guide
Avatar for Daisuke Masuda x5gtrn
PRO
0
1.3k
肥大化するレガシーコードに立ち向かうためのインターフェース分離と依存の逆転 / JJUG CCC 2026 Spring
Avatar for hirokuni-maeta hirokunimaeta
0
620
Skillsは効率化、Agentsは"自分の拡張"——Builder時代のエージェント編成（CC Night 2026）
Avatar for Hiroki Uemura wemra
1
160
Signal Forms: Details & Live Coding @enterJS 2026 in Mannheim
Avatar for Manfred Steyer manfredsteyer
PRO
0
190
The ROI of Quarkus for Spring Boot Applications
Avatar for Holly Cummins hollycummins
0
140
Spring Security 実践 ─ GraphQL APIで実務に役立つ 認証・認可 を学ぶ
Avatar for Wagyu wagyu
0
260
はてなアカウント基盤 State of the Union
Avatar for cockscomb cockscomb
1
730
そのテスト、説明できますか？~LWテスト戦略FW~のご紹介
Avatar for Kei Nakahara nakahara
0
170
Lessons from Spec-Driven Development
Avatar for Simon Martinelli simas
PRO
0
220
AIで効率化できた業務・日常
Avatar for Ochtum ochtum
0
150

Featured

See All Featured
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
Avatar for Eileen M. Uchitelle eileencodes
28
3.5k
Reality Check: Gamification 10 Years Later
Avatar for Sebastian Deterding codingconduct
0
2.2k
Faster Mobile Websites
Avatar for Dean Hume deanohume
310
32k
Abbi's Birthday
Avatar for Violet Bock coloredviolet
3
8.2k
Making Projects Easy
Avatar for Brett Harned brettharned
120
6.7k
Money Talks: Using Revenue to Get Sh*t Done
Avatar for Nikki Halliwell nikkihalliwell
0
260
4 Signs Your Business is Dying
Avatar for Josh Pigford shpigford
187
22k
svc-hook: hooking system calls on ARM64 by binary rewriting
Avatar for Akira Moroo retrage
2
310
The Spectacular Lies of Maps
Avatar for Per Axbom axbom
PRO
1
820
Ecommerce SEO: The Keys for Success Now & Beyond - #SERPConf2024
Avatar for Aleyda Solis aleyda
1
2k
Build The Right Thing And Hit Your Dates
Avatar for Maggie C. maggiecrowley
39
3.2k
How to Grow Your eCommerce with AI & Automation
Avatar for Katarina Dahlin katarinadahlin
PRO
1
210

Transcript

  1. 20 Building Better API Documentation

  2. The right things aren’t hard to do but the wrong

    things are even easier.

  3. Write your own documentation.

  4. This is not documentation.

  5. This is not documentation.

  6. This is not documentation.

  7. 39.953648, -75.198787 39.956662, -75.198005 39.954598, -75.181354 40.024722, -75.226907 40.025576, -75.228624

    40.029487, -75.223517 40.027318, -75.221929 Directions to My Neighborhood

  8. 1. Exit building to 38th. 2. Turn right on Market.

    3. Turn left on to I-76 W. 4. Take exit #338. 5. Turn right on Green. 6. Turn right on Silverwood. 7. Stop at Levering. Directions to My Neighborhood

  9. Doc generators are source code viewers without the source.

  10. Tasks Topics References

  11. Tasks

  12. None

  13. Topics

  14. None

  15. References

  16. None

  17. Tasks Topics References

  18. Better living through documentation.

  19. Questions? Comments? True stories of adventure? @ddbeck danieldbeck.com slides @

    http://speakerdeck.com/u/ddbeck