Why SDK Docs Matter — And What I’m Doing About It!
summary
Users land on Github and confuse similar client libraries so 25 sdks produce wrong choices; solution creates a per‑sdk table of sdks, a visible decision diagram (green/red) plus a TOC, license and contribute sections, and a separate common docs repo for shared reference. Tutorials and code samples get end‑to‑end testing and a maintenance reminder to update docs with each release. A customer follows the new flow successfully and UX feedback is positive, so the changes reduce mis‑installs and clarify when to pick which sdk.
AI-written summary · about
chapters (19)
- 0:00Intro
- 0:25What is an SDK
- 1:06What is a good SDK
- 1:32Who uses an SDK
- 2:05Consistency
- 2:42Problem
- 4:50The Big Picture
- 8:52The Table
- 9:59The Diagram
- 12:25Table of Contents
- 13:12Common Content
- 15:15Maintain Consistency
- 16:54Add Tutorials
- 22:39User Researcher Feedback
- 23:49Testing Documentation
- 25:38Common Documentation Errors
- 27:44Decision Trees
- 30:23Reference Documentation
- 32:39Conclusion
related talks
43mUseful and Beautiful Developer Docs and How to Create Them
32mBest Practices in SDK Development
44mUseful and Beautiful Developer Docs and How to Create Them
39mDevelopers Documentation: your hidden strength
53mHow not to fuckup with building SDK and make clients happy
35mThe Art of Documentation and Readme.md for Open Source Projects
24mEscaping the Curse of Outdated Docs
48mUseful and Beautiful Developer Docs and How to Create Them