亲爱的SDK开发人员

我们的工作之一是通过SDK集成第三项服务。 如果这是一个好选择,那么对我们来说很幸运,它可以极大地提高我们的生产率。 如果不好,请通过集成和错误跟踪来为噩梦做准备。

我已经看到了带有很多编译器警告的传统SDK,这些警告已经有一段时间没有更新了。 我已经看到,SDK引入了另外34个其他依赖项,完全没有变更日志和文档的SDK,由于错误的假设而破坏了其他SDK的SDK,…

  • 请不要摇晃 。 向我们提供有关在何处调用您的API的说明,而不要进行不必要的麻烦。 您正在为开发人员使用它,他们知道如何编写代码。 大多数时候,你不知道该怎么做正确right
  • 请不要使用配置文件 。 如果可能的话,请考虑通过纯代码进行配置,而不是通过应用包中更容易暴露的plist文件进行配置。
  • 请不要对应用程序做任何假设 。 您对将要集成SDK的应用程序的假设并不总是正确的。 每个应用程序都有其自己的用例和视图层次结构。
  • 请提供适当的版本 。 标记并发布SDK中的新更改。 如果有重大更改,则应该有迁移指南,并将其影响到较旧的应用程序。 另外,请在发行说明或变更日志文件中写入适当的变更日志。
  • 请不要给我们留下转储头文件 。 请向所有功能添加文档。
  • 请改进自述文件 。 为避免所有猜测,请通过详细说明改进自述文件。
  • 请包括一个示例演示项目 。 在进行演示项目时,您有机会解决潜在的问题。 开发人员可以了解可能缺少的步骤。
  • 请开源 。 您在出售服务,而不是代码。 通过开源,每个人都清楚代码,它们可能会帮助您解决错误和提出建议。

老实说,当我被要求将SDK与不良文档和封闭源代码集成时,我感到非常害怕。 就像玩猜谜游戏。

如果该服务对您而言并不重要,而您正在做它只是为了娱乐,那么您可以忽略这些请求。 但是,如果您对此很认真,则请考虑正确执行。

对不起,对不起。 我们在一起可以使世界变得更美好。 谢谢❤️


如果您喜欢这篇文章,请考虑访问我的其他文章和应用