Best Practices in SDK Development

on YouTube ↗32m

" summary

32-minute practical checklist focused on SDK craft: use explicit access control and keep your API surface small (avoids the 40–50 exposed types problem), namespace via structs/enums, prefer typed request/response and settings structs over primitives, use enums for closed options and structs for customizable styles, write tests against the public API (watch out for Testable import pitfalls), publish DocC with manual topics, adopt semver after 1.0, and handle breaking changes via deprecations and typealias + @available renamed or message guidance.

AI-written summary · about

" chapters (8)

1. 0:00Introduction and speaker intro
2. 4:23What is an SDK
3. 7:12API design best practices
4. 13:17System design stability
5. 18:59Testing public API
6. 20:42Documentation strategies
7. 24:13Versioning and deprecations
8. 30:58Final takeaways and Q&A

" related talks

• 28mLessons From Becoming an SDK DeveloperOscar Swanros · iOS Conf Singapore 2019
• 26mDesigning Accessible APIsDave DeLong · try! Swift NYC 2019
• 22mBest Practices When Building Mobile SDKsEmma Tresanszki · Android Summit 2017
• 34mWhy SDK Docs Matter — And What I’m Doing About It!Shavindri Dissanayake (Shavi) · Write the Docs Portland 2020
• 32mHow to successfully shift from app development to SDK developmentNelson Puglisi · droidcon Berlin 2023
• 27mSDKs & Code Samples, The Cornerstone of API Developer ExperienceAdeel Ali · apidays Singapore 2019
• 53mHow not to fuckup with building SDK and make clients happyVitaliy Zasadnyy · DevFest Nantes 2017
• 22mMake your APIs Developer-friendlyAidan Cunniffe · DevX Conf 2021