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
Spinner 軸ズレ現象を調べたらレンダリング深淵に飲まれた #レバテックMeetup
Avatar for 弁護士ドットコム bengo4com
1
230
フロントエンド開発の勘所 -複数事業を経験して見えた判断軸の違い-
Avatar for Yoichiro Kubo heimusu
7
2.8k
CSC307 Lecture 01
Avatar for Javier Gonzalez-Sanchez javiergs
PRO
0
690
AI Agent Tool のためのバックエンドアーキテクチャを考える #encraft
Avatar for izumin5210 izumin5210
6
1.8k
Unicodeどうしてる？ PHPから見たUnicode対応と他言語での対応についてのお伺い
Avatar for てきめん tekimen youkidearitai
PRO
1
1.1k
SourceGeneratorのススメ
Avatar for tkym htkym
0
190
そのAIレビュー、レビューしてますか？ / Are you reviewing those AI reviews?
Avatar for r-kagaya rkaga
6
4.5k
MUSUBIXとは
Avatar for Hisaho nahisaho
0
130
Architectural Extensions
Avatar for Denys Poltorak denyspoltorak
0
270
AIで開発はどれくらい加速したのか？AIエージェントによるコード生成を、現場の評価と研究開発の評価の両面からdeep diveしてみる
Avatar for どすこい daisuketakeda
1
970
Vibe codingでおすすめの言語と開発手法
Avatar for uyuki uyuki234
0
220
コマンドとリード間の連携に対する脅威分析フレームワーク
Avatar for Aja9tochin pandayumi
1
450

Featured

See All Featured
Data-driven link building: lessons from a $708K investment (BrightonSEO talk)
Avatar for Szymon szymonslowik
1
910
Building Adaptive Systems
Avatar for Chris Keathley keathley
44
2.9k
Making the Leap to Tech Lead
Avatar for Ryan Cromwell cromwellryan
135
9.7k
Facilitating Awesome Meetings
Avatar for Lara Hogan lara
57
6.7k
sira's awesome portfolio website redesign presentation
Avatar for ElsiraPls elsirapls
0
140
The untapped power of vector embeddings
Avatar for Frank van Dijk frankvandijk
1
1.6k
How to make the Groovebox
Avatar for あそなす asonas
2
1.9k
Design in an AI World
Avatar for tapps tapps
0
140
A Modern Web Designer's Workflow
Avatar for Chris Coyier chriscoyier
698
190k
How to train your dragon (web standard)
Avatar for Monica Dinculescu notwaldorf
97
6.5k
Fantastic passwords and where to find them - at NoRuKo
Avatar for Phil Nash philnash
52
3.6k
JavaScript: Past, Present, and Future - NDC Porto 2020
Avatar for David Neal reverentgeek
52
5.8k

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