在过去的十年中，SDK的使用已经成为开发生命周期的重要组成部分。事实上，它在产品中的应用和集成已经非常普遍。即使对于开发者来说，理解框架知识的重要性也高于学习算法本身。在今天的文章中，我们将学习十个技术，希望它们能帮助您创建最好的SDK：0.了解现有的成果在做之前，我们首先需要了解竞争对手或其他公司是否已经完成了预期的SDK解决方案。这种方案可以作为一个很好的参考点，不妨从中取其精华，去其糟粕。1.简单简单的代码确保易于使用的结果。具体来说，代码交互的方式越少越好，比如只提供一个接口类；减少方法签名，例如只保留少数输入参数等。除了初始化之外，SDK的使用方式应尽可能简单。为了实现这个目标，你可以提供一个默认的配置和默认的实现类，同时允许高级用户修改它。隐藏所有用户不需要使用的类和方法，即只在用户需要时才打开类/方法，否则只在本地或私有范围内使用。一些IDE可以帮助您自动实现代码检测和冗余部分去除。文档：使文档尽可能易于理解，即提供足够的解释但注意不要冗长。此外，内联代码示例是获得提示的好方法。2、保证好用是指保证用户在5分钟内学会使用代码。这一点非常重要，尤其是考虑到有时用户会对我们的产品进行评价——如果他们不能轻易上手，他们可能会干脆选择放弃。3.Keepitshort这部分要求对于文档来说尤为重要，但有时也会体现在用户与SDK代码的交互过程中。为了使文档简洁，您应该提供代码示例、使用一目了然的方法名称并提供默认配置。4.集成我们必须记住，用户通常有多种开发环境。比如我们在写一个Android库，我们需要充分考虑元素的集成：如果用户使用AndroidStudio和gradle，我们必须提供aarartifact，发布到远程库；如果用户使用Eclipse，我们需要提供修改AndroidManifest.xml必要的jar文件和SDK独立的eclipse工程。当然，这部分工作不可能一蹴而就。大家可以在项目进行过程中多听取意见，逐步融入更多的融合元素。5.示例工程在GitHub中创建一个基础工程，模拟客户使用SDK的过程。通过这种方式，我们可以了解客户如何使用产品来满足他们的需求，以及他们可能有哪些产品集成需求。如果您打算演示一些高级用法，您应该创建另一个单独的项目。通常，用户会使用它作为他们的主要文档来源，因此提供内联注释并编写尽可能不言自明的代码。6.概述在文档或README中提供解决方案的一般概述。在这里，我通常会提供一个示例用例来解释SDK的一般用法。如果可能，提供简单的图表或图例，以帮助没有时间逐行阅读文本的用户快速学习如何使用它。7.快速上手使用SDK领域公认的、常规的方法。尽量使用常规的加载、构建模式等设计思路，确保默认配置能够有效帮助用户快速上手使用项目。8、默认配置一个好的默认配置可以有效的提高代码的简洁性，降低调整的难度。我们提供的默认机制（配置方案和实现）应该适用于大多数SDK目标用户。您可以提供多种重载方法，其中最简单的方法签名将默认调用更复杂的方法签名。9.以不可编辑的离线格式发布-PDF。我们能够轻松创建此说明材料并将其保存在Dropbox上以供将来更新。在线-创建公司网站。这很理想，但它的更新工作也会给IT团队带来一定的负担。我希望这些技巧可以帮助您构建自己的***SDK！原标题：10TipsonHowtoBuildthePerfectSDK
