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

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
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
IFSによる形状設計／デモシーンの魅力 @ 慶應大学SFC
Avatar for がむ gam0022
1
300
Fluid Templating in TYPO3 14
Avatar for Simon Praetorius s2b
0
130
Automatic Grammar Agreementと Markdown Extended Attributes
について
Avatar for Kishikawa Katsumi kishikawakatsumi
0
180
0→1 フロントエンド開発 Tips🚀 #レバテックMeetup
Avatar for 弁護士ドットコム bengo4com
0
540
CSC307 Lecture 05
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
0
500
HTTPプロトコル正しく理解していますか？ 〜かわいい猫と共に学ぼう。ฅ^•ω•^ฅ ﾆｬ〜
Avatar for ♛Heitor Hirose hekuchan
2
680
CSC307 Lecture 03
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
1
490
Smart Handoff/Pickup ガイド - Claude Code セッション管理
Avatar for rasshii yukiigarashi
0
130
Fragmented Architectures
Avatar for Denys Poltorak denyspoltorak
0
150
FOSDEM 2026: STUNMESH-go: Building P2P WireGuard Mesh Without Self-Hosted Infrastructure
Avatar for Date Huang tjjh89017
0
150
組織で育むオブザーバビリティ
Avatar for ryotaro kobayashi ryota_hnk
0
170
AI時代のキャリアプラン「技術の引力」からの脱出と「問い」へのいざない / tech-gravity
Avatar for MinoDriven minodriven
20
6.8k

Featured

See All Featured
How to Build an AI Search Optimization Roadmap - Criteria and Steps to Take #SEOIRL
Avatar for Aleyda Solis aleyda
1
1.9k
Optimizing for Happiness
Avatar for Tom Preston-Werner mojombo
379
71k
Utilizing Notion as your number one productivity tool
Avatar for Mfonobong Umondia mfonobong
2
210
The Web Performance Landscape in 2024 [PerfNow 2024]
Avatar for Tammy Everts tammyeverts
12
1k
The Illustrated Children's Guide to Kubernetes
Avatar for Chris Short chrisshort
51
51k
End of SEO as We Know It (SMX Advanced Version)
Avatar for Michael King ipullrank
3
3.9k
How to Create Impact in a Changing Tech Landscape [PerfNow 2023]
Avatar for Tammy Everts tammyeverts
55
3.2k
jQuery: Nuts, Bolts and Bling
Avatar for Doug Neiner dougneiner
65
8.4k
For a Future-Friendly Web
Avatar for Brad Frost brad_frost
182
10k
SEO in 2025: How to Prepare for the Future of Search
Avatar for Michael King ipullrank
3
3.3k
Sharpening the Axe: The Primacy of Toolmaking
Avatar for Bryan Cantrill bcantrill
46
2.7k
Data-driven link building: lessons from a $708K investment (BrightonSEO talk)
Avatar for Szymon szymonslowik
1
910

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