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
1
140

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
Tweet

Other Decks in Programming

See All in Programming
Things You Thought You Didn’t Need To Care About That Have a Big Impact On Your Job
Avatar for Holly Cummins hollycummins
0
180
エンジニアとして高みを目指す、 利益を生み出す設計の考え方 / design-for-profit
Avatar for MinoDriven minodriven
7
4.9k
Android 16 × Jetpack Composeで縦書きテキストエディタを作ろう / Vertical Text Editor with Compose on Android 16
Avatar for cc4966 cc4966
2
1.1k
パフォーマンスチューニングで Web 技術を深掘り直す
Avatar for Shunsuke Mano progfay
17
4.3k
Local Peer-to-Peer APIはどのように使われていくのか？
Avatar for Hal hal_spidernight
2
280
Tool Catalog Agent for Bedrock AgentCore Gateway
Avatar for matsukada licux
7
2.7k
Deep Dive into Kotlin Flow
Avatar for Matsuda Jumpei jmatsu
1
420
Breaking Up with Big ViewModels — Without Breaking Your Architecture (droidcon Berlin 2025)
Avatar for Stelios Frantzeskakis steliosf
PRO
1
170
プログラミングどうやる？ ～テスト駆動開発から学ぶ達人の型～
Avatar for Atsushi Okui a_okui
0
180
CSC509 Lecture 01
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
1
420
How Android Uses Data Structures Behind The Scenes
Avatar for HyunWoo Lee l2hyunwoo
1
530
VisionFrameworkで実現する - プライバシーに配慮した「顔ぼかし」機能 / Face blurring with Vision Framework
Avatar for Tomohiro Imaizumi imaizume
0
110

Featured

See All Featured
How to Ace a Technical Interview
Avatar for Jacob Kaplan-Moss jacobian
280
23k
Build your cross-platform service in a week with App Engine
Avatar for Jose L jlugia
231
18k
The Invisible Side of Design
Avatar for Vitaly Friedman smashingmag
301
51k
Imperfection Machines: The Place of Print at Facebook
Avatar for Scott Boms scottboms
269
13k
Become a Pro
Avatar for Speaker Deck speakerdeck
PRO
29
5.5k
Thoughts on Productivity
Avatar for Jon Yablonski jonyablonski
70
4.8k
The Art of Programming - Codeland 2020
Avatar for Erika Heidi erikaheidi
56
13k
Building Better People: How to give real-time feedback that sticks.
Avatar for Will Jessup wjessup
368
20k
Gamification - CAS2011
Avatar for David Bonilla davidbonilla
81
5.4k
Producing Creativity
Avatar for Steve Smith orderedlist
PRO
347
40k
Rebuilding a faster, lazier Slack
Avatar for samanthasiow samanthasiow
84
9.2k
Designing Experiences People Love
Avatar for Jonathan Moore moore
142
24k

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