Upgrade to Pro — share decks privately, control downloads, hide ads and more …
Sign up for free

Building Better API Documentation

Sponsored · SiteGround - Reliable hosting with speed, security, and support you can count on. →
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
FactoryBotをやめればRSpecは速くなるのか？
Avatar for nissyi yuta_onishi_97
0
370
[ハンズオン]AIへの指示だけで「五目並べ」を作ってみよう
Avatar for Satoshi Kaneyasu satoshi256kbyte
1
380
AIに “答え“を書かせるのを やめてみた
Avatar for akari ___akari11
0
120
全ての永続トークンを、生まれる前に消し去りたい！
Avatar for sylph01 sylph01
2
890
Domain-Driven Transformation
Avatar for Henning Schwentner hschwentner
2
2.3k
Workers Cache を知る
Avatar for syumai syumai
0
360
Railsのためのパスキー実践入門 〜マルチテナントSaaSでの意思決定〜
Avatar for utakaha utakaha
2
560
JIS keyboard support in Omarchy
Avatar for LEF lef237
0
110
[Rails World 2026] Durable orchestration on Rails: from continuation to workflow
Avatar for Vladimir Dementyev palkan
1
750
現場と育てるRailsモデリング 〜Spreadsheetから始めたモデル設計〜
Avatar for siroemk siroemk
2
590
Atomic Design, Enforced: Scaling Mobile Design Systems (next.app devCon / droidCon Berlin 2026)
Avatar for Stelios Frantzeskakis steliosf
PRO
0
170
パズルゲームの作り方 / how to make puzzle games
Avatar for kaityo256 kaityo256
PRO
2
290

Featured

See All Featured
Tell your own story through comics
Avatar for letsgokoyo letsgokoyo
1
1.1k
Build The Right Thing And Hit Your Dates
Avatar for Maggie C. maggiecrowley
39
3.5k
Self-Hosted WebAssembly Runtime for Runtime-Neutral Checkpoint/Restore in Edge–Cloud Continuum
Avatar for Yuki Nakata chikuwait chikuwait
0
890
Exploring anti-patterns in Rails
Avatar for Elle Meredith aemeredith
4
540
Visual Storytelling: How to be a Superhuman Communicator
Avatar for David Neal reverentgeek
2
710
Why Your Marketing Sucks and What You Can Do About It - Sophie Logan
Avatar for Sophie Logan marketingsoph
0
430
Building a Scalable Design System with Sketch
Avatar for Laura Van Doore lauravandoore
464
34k
JavaScript: Past, Present, and Future - NDC Porto 2020
Avatar for David Neal reverentgeek
52
6.1k
Why Our Code Smells
Avatar for Brandon Keepers bkeepers
PRO
340
58k
Paper Plane
Avatar for Katie Cordina Lindsey katiecoart
PRO
5
54k
Groundhog Day: Seeking Process in Gaming for Health
Avatar for Sebastian Deterding codingconduct
0
410
Introduction to Domain-Driven Design and Collaborative software design
Avatar for Kenny Baas-Schwegler baasie
1
1k

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