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
AI前提で考えるiOSアプリのモダナイズ設計
Avatar for 野瀬田　裕樹 yuukiw00w
0
220
Fluid Templating in TYPO3 14
Avatar for Simon Praetorius s2b
0
130
AIフル活用時代だからこそ学んでおきたい働き方の心得
Avatar for shinoyu shinoyu
0
130
CSC307 Lecture 09
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
1
830
Smart Handoff/Pickup ガイド - Claude Code セッション管理
Avatar for rasshii yukiigarashi
0
130
Rust 製のコードエディタ “Zed” を使ってみた
Avatar for NearMeの技術発表資料です nearme_tech
PRO
0
160
Basic Architectures
Avatar for Denys Poltorak denyspoltorak
0
660
MDN Web Docs に日本語翻訳でコントリビュート
Avatar for uutan1108 ohmori_yusuke
0
650
16年目のピクシブ百科事典を支える最新の技術基盤 / The Modern Tech Stack Powering Pixiv Encyclopedia in its 16th Year
Avatar for ahu ahuglajbclajep
5
1k
高速開発のためのコード整理術
Avatar for sutetotanuki sutetotanuki
1
390
CSC307 Lecture 05
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
0
500
humanlayerのブログから学ぶ、良いCLAUDE.mdの書き方
Avatar for Yuto tsukamoto1783
0
190

Featured

See All Featured
Intergalactic Javascript Robots from Outer Space
Avatar for Vicent Martí tanoku
273
27k
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
Avatar for Stéphanie Walter stephaniewalter
287
14k
Save Time (by Creating Custom Rails Generators)
Avatar for Garrett Dimon garrettdimon
PRO
32
2.1k
Chasing Engaging Ingredients in Design
Avatar for Sebastian Deterding codingconduct
0
110
Reality Check: Gamification 10 Years Later
Avatar for Sebastian Deterding codingconduct
0
2k
SEOcharity - Dark patterns in SEO and UX: How to avoid them and build a more ethical web
Avatar for Sara Fernández Carmona sarafernandez
0
120
The Psychology of Web Performance [Beyond Tellerrand 2023]
Avatar for Tammy Everts tammyeverts
49
3.3k
Understanding Cognitive Biases in Performance Measurement
Avatar for Philip Tellis bluesmoon
32
2.8k
A brief & incomplete history of 
UX Design for the World Wide Web: 1989–2019
Avatar for Jason CranfordTeague jct
1
300
Primal Persuasion: How to Engage the Brain for Learning That Lasts
Avatar for Mike Taylor tmiket
0
250
What the history of the web can teach us about the future of AI
Avatar for Ines Montani inesmontani
PRO
1
430
So, you think you're a good person
Avatar for Per Axbom axbom
PRO
2
1.9k

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