Effectively Producing And Shipping Frameworks For Multiple Platforms
0 likesā¢3,654 views
The document outlines the processes of effectively producing and distributing software development kits (SDKs) across multiple platforms. It covers elements such as SDK design, distribution practices, and the importance of clear documentation and support for developers. Additionally, it emphasizes the significance of maintaining a consistent public API and being kind to SDK users during support interactions.
Effectively Producing And Shipping Frameworks For Multiple Platforms
- 1. EFFECTIVELY PRODUCING AND SHIPPING FRAMEWORKS FOR MULTIPLE PLATFORMS DONNY WALS
- 2. EFFECTIVELY PRODUCING AND SHIPPING FRAMEWORKS FOR MULTIPLE PLATFORMS AGENDA
- 3. EFFECTIVELY PRODUCING AND SHIPPING FRAMEWORKS FOR MULTIPLE PLATFORMS AGENDA āø An introduction to SDKs
- 4. EFFECTIVELY PRODUCING AND SHIPPING FRAMEWORKS FOR MULTIPLE PLATFORMS AGENDA āø An introduction to SDKs āø Designing an SDK
- 5. EFFECTIVELY PRODUCING AND SHIPPING FRAMEWORKS FOR MULTIPLE PLATFORMS AGENDA āø An introduction to SDKs āø Designing an SDK āø Distributing your SDK to developers
- 6. EFFECTIVELY PRODUCING AND SHIPPING FRAMEWORKS FOR MULTIPLE PLATFORMS AGENDA āø An introduction to SDKs āø Designing an SDK āø Distributing your SDK to developers āø Closing remarks
- 8. SDK
- 11. SDK SOFTWARE DEVELOPMENT KIT Android SDK iOS SDK
- 12. SDK SOFTWARE DEVELOPMENT KIT Android SDK iOS SDK Firebase SDK
- 13. SDK SOFTWARE DEVELOPMENT KIT Android SDK iOS SDK Firebase SDK Google Maps SDK
- 14. SDK SOFTWARE DEVELOPMENT KIT Android SDK iOS SDK Firebase SDK Google Maps SDK And many others...
- 15. SDK
- 16. SDK It's really just a tool that makes it easy to integrate certain features in your app.
- 17. Your project
- 21. Your project Remote server SDK Complex system
- 22. Your project Remote server SDK SDK Complex system
- 23. Your project Remote server SDK SDK Complex system
- 24. Your project Remote server SDK SDK SDK Complex system Low level API
- 25. Your project Remote server SDK SDK SDK Complex system Low level API AN SDK WILL USUALLY ACT AS AN INTERFACE BETWEEN A COMPLICATED "THING" AND YOUR CODE
- 26. A GOOD SDK ALLOWS YOU TO TURN THIS
- 27. A GOOD SDK ALLOWS YOU TO TURN THIS CALCULATE SOME ARBITRARY SIGNATURE
- 28. A GOOD SDK ALLOWS YOU TO TURN THIS CALCULATE SOME ARBITRARY SIGNATURE APPLY AUTHENTICATION
- 29. A GOOD SDK ALLOWS YOU TO TURN THIS CALCULATE SOME ARBITRARY SIGNATURE APPLY AUTHENTICATION REFRESH TOKEN AND RETRY?
- 30. INTO THIS
- 32. Account services Media services Feed services Push services etc...
- 33. Account services Media services Feed services Push services etc... Local store Filesystem
- 34. Account services Media services Feed services Push services etc... SDK Local store Filesystem
- 35. Account services Media services Feed services Push services etc... SDK Local store Filesystem
- 36. Account services Media services Feed services Push services etc... SDK Local store Filesystem
- 37. HOW APPS ARE (OFTEN) DESIGNED
- 38. HOW APPS ARE (OFTEN) DESIGNED Designer
- 39. HOW APPS ARE (OFTEN) DESIGNED Designer
- 40. HOW APPS ARE (OFTEN) DESIGNED Designer
- 41. HOW APPS ARE (OFTEN) DESIGNED Designer
- 42. HOW APPS ARE (OFTEN) DESIGNED Designer
- 43. HOW APPS ARE (OFTEN) DESIGNED Designer
- 44. HOW APPS ARE (OFTEN) DESIGNED Designer
- 45. HOW APPS ARE (OFTEN) DESIGNED Designer
- 46. THE SDK DESIGN PROCESS
- 47. THE SDK DESIGN PROCESS JavascriptiOS Android
- 48. THE SDK DESIGN PROCESS Javascript iOS Android
- 49. THE SDK DESIGN PROCESS JavascriptiOS Android
- 50. THE SDK DESIGN PROCESS JavascriptiOS Android
- 51. THE SDK DESIGN PROCESS JavascriptiOS Android
- 52. THE SDK DESIGN PROCESS JavascriptiOS Android
- 53. THE SDK DESIGN PROCESS JavascriptiOS Android
- 54. THE SDK DESIGN PROCESS JavascriptiOS Android NATIVE CODE
- 55. THE SDK DESIGN PROCESS
- 56. THE SDK DESIGN PROCESS A CONSISTENT PUBLIC API MAKES IT EASIER TO REASON ABOUT THE WAY AN SDK SHOULD BE INTEGRATED.
- 57. THE SDK DESIGN PROCESS
- 58. THE SDK DESIGN PROCESS
- 59. THE SDK DESIGN PROCESS
- 60. THE SDK DESIGN PROCESS
- 61. THE SDK DESIGN PROCESS SIMILARITIES IN FIREBASE
- 62. THE SDK DESIGN PROCESS SIMILARITIES IN FIREBASE āø All platforms use a set / setValue style syntax
- 63. THE SDK DESIGN PROCESS SIMILARITIES IN FIREBASE āø All platforms use a set / setValue style syntax āø All platforms must obtain a ref to the database
- 64. THE SDK DESIGN PROCESS SIMILARITIES IN FIREBASE āø All platforms use a set / setValue style syntax āø All platforms must obtain a ref to the database āø The examples all used a similar use case
- 65. THE SDK DESIGN PROCESS
- 66. THE SDK DESIGN PROCESS A consistent public API allows app developers to exchange knowledge about your SDK regardless of the platform they work on.
- 67. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3
- 68. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3 āø Describe the feature in detail
- 69. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3 āø Describe the feature in detail āø Provide as much context as needed / possible
- 70. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3 āø Describe the feature in detail āø Provide as much context as needed / possible āø Link to external documentation and information if possible
- 71. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3 āø Describe the feature in detail āø Provide as much context as needed / possible āø Link to external documentation and information if possible āø Stay on point, be concise but also precise
- 72. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3
- 73. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3
- 74. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3 Gherkin: GIVEN/WHEN/THEN
- 75. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3 Gherkin: GIVEN/WHEN/THEN āø Given: An account manager instance and valid login credentials.
- 76. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3 Gherkin: GIVEN/WHEN/THEN āø Given: An account manager instance and valid login credentials. āø When: Calling login() on the account manager with the correct credentials.
- 77. THE SDK DESIGN PROCESS DESIGNING A NEW FEATURE Step 1 Step 2 Step 3 Gherkin: GIVEN/WHEN/THEN āø Given: An account manager instance and valid login credentials. āø When: Calling login() on the account manager with the correct credentials. āø Then: A LoginResult with a success state should be returned eventually
- 80. DISTRIBUTING YOUR SDK āø Bump version as needed
- 81. DISTRIBUTING YOUR SDK āø Bump version as needed āø Deploy your SDK update
- 82. DISTRIBUTING YOUR SDK āø Bump version as needed āø Deploy your SDK update āø Clearly communicate changes to consumers
- 83. DISTRIBUTING YOUR SDK āø Bump version as needed āø Deploy your SDK update āø Clearly communicate changes to consumers āø Ensure your documentation is up to date
- 84. DISTRIBUTING YOUR SDK āø Bump version as needed āø Deploy your SDK update āø Clearly communicate changes to consumers āø Ensure your documentation is up to date āø Provide support to consumers
- 85. DISTRIBUTING YOUR SDK BUMPING YOUR SDK VERSION
- 86. DISTRIBUTING YOUR SDK BUMPING YOUR SDK VERSION āø Not every platform has to be on the same version.
- 87. DISTRIBUTING YOUR SDK BUMPING YOUR SDK VERSION āø Not every platform has to be on the same version. āø Don't worry about releasing often, but try to limit your breaking changes.
- 88. DISTRIBUTING YOUR SDK DEPLOY YOUR SDK UPDATE
- 89. DISTRIBUTING YOUR SDK DEPLOY YOUR SDK UPDATE āø Set up CI to distribute your SDK to the distribution channel of your choice.
- 90. DISTRIBUTING YOUR SDK DEPLOY YOUR SDK UPDATE āø Set up CI to distribute your SDK to the distribution channel of your choice. āø Open-source, closed-source, pick the one you need for your SDK.
- 91. DISTRIBUTING YOUR SDK DEPLOY YOUR SDK UPDATE āø Set up CI to distribute your SDK to the distribution channel of your choice. āø Open-source, closed-source, pick the one you need for your SDK. āø Sometimes you need both, for instance when you ship your SDK to a third party.
- 92. DISTRIBUTING YOUR SDK COMMUNICATE CHANGES
- 93. DISTRIBUTING YOUR SDK COMMUNICATE CHANGES āø Use a CHANGELOG.md so it's easy to document changes.
- 94. DISTRIBUTING YOUR SDK COMMUNICATE CHANGES āø Use a CHANGELOG.md so it's easy to document changes. āø If appropriate, send out an email, slack message or other notiļ¬cation to your SDK users with changes for the latest version.
- 95. DISTRIBUTING YOUR SDK COMMUNICATE CHANGES āø Use a CHANGELOG.md so it's easy to document changes. āø If appropriate, send out an email, slack message or other notiļ¬cation to your SDK users with changes for the latest version. āø Be clear, and be thorough. These update notes are way more important than your regular app update notes ("Bug ļ¬xes and other improvements").
- 96. DISTRIBUTING YOUR SDK UPDATE YOUR DOCUMENTATION
- 97. DISTRIBUTING YOUR SDK UPDATE YOUR DOCUMENTATION āø Pay extra attention to your code samples and getting started guides.
- 98. DISTRIBUTING YOUR SDK UPDATE YOUR DOCUMENTATION āø Pay extra attention to your code samples and getting started guides. āø Broken documentation is extremely frustrating for people that use your SDK, especially if they are new.
- 99. DISTRIBUTING YOUR SDK PROVIDE SUPPORT
- 100. DISTRIBUTING YOUR SDK PROVIDE SUPPORT āø Set up a Slack channel, mailing list, use Github or anything else that you think makes sense.
- 101. DISTRIBUTING YOUR SDK PROVIDE SUPPORT āø Set up a Slack channel, mailing list, use Github or anything else that you think makes sense. āø Be welcoming and kind, nobody knows your SDK like the team that built it.
- 102. CLOSING REMARKS
- 103. CLOSING REMARKS
- 104. CLOSING REMARKS āø Just like users, other developers will ļ¬nd ways to use your SDK that you didn't think were possible.
- 105. CLOSING REMARKS āø Just like users, other developers will ļ¬nd ways to use your SDK that you didn't think were possible. āø Your SDK will contain bugs, and developers will tell you about them.
- 106. CLOSING REMARKS āø Just like users, other developers will ļ¬nd ways to use your SDK that you didn't think were possible. āø Your SDK will contain bugs, and developers will tell you about them. āø Be kind to SDK users when they call out for support, they often don't understand the SDK on the level you do.
- 107. CLOSING REMARKS āø Just like users, other developers will ļ¬nd ways to use your SDK that you didn't think were possible. āø Your SDK will contain bugs, and developers will tell you about them. āø Be kind to SDK users when they call out for support, they often don't understand the SDK on the level you do. āø Avoid staying in "spec review" for too long. Avoid bike-shedding.
- 108. CLOSING REMARKS āø Just like users, other developers will ļ¬nd ways to use your SDK that you didn't think were possible. āø Your SDK will contain bugs, and developers will tell you about them. āø Be kind to SDK users when they call out for support, they often don't understand the SDK on the level you do. āø Avoid staying in "spec review" for too long. Avoid bike-shedding. āø Don't rush either, your code directly impacts the quality of apps you don't control.
- 109. CLOSING REMARKS āø Just like users, other developers will ļ¬nd ways to use your SDK that you didn't think were possible. āø Your SDK will contain bugs, and developers will tell you about them. āø Be kind to SDK users when they call out for support, they often don't understand the SDK on the level you do. āø Avoid staying in "spec review" for too long. Avoid bike-shedding. āø Don't rush either, your code directly impacts the quality of apps you don't control. āø Not having any UI to test your code with forces you to write (good) unit tests, which is very interesting to experience.
- 110. EFFECTIVELY PRODUCING AND SHIPPING FRAMEWORKS FOR MULTIPLE PLATFORMS DONNY WALS