库开发指南
库的作者往往会小心翼翼呵护自己的作品,一个库的诞生过程就是作者的心路历程和思考问题的方式,我们来捋一捋,库的开发,需要经历哪些步骤:
阶段 | 工作 | 交付产物 | 能力 |
---|---|---|---|
设计API | 简单来讲,设计API的工作就是在确定输入与输出的规范 | API签名 | 场景梳理能力(设计的API要易于扩展) 、设计模式 |
设计测试用例 | 基于前一步设计的API,设计测试用例,由于个人存在视野盲区,这个过程可借助AI | 测试用例集合 | 思维严谨性(尽量考虑更多的边界情况) |
实现测试用例 | 按照设计的测试用例,提前把用例全部写好,此时如果运行,将全部报错 | 测试用例代码 | / |
实现API | 按照第一步设计的API进行实现 | 代码 | 编码能力 |
运行测试用例 | 重跑所有测试用例 | 100%通过率 | / |
到这里,代码的设计与实现过程结束,此时得到的已经是一个 经过充分测试的,已经可以使用的API 。
但要让用户能够使用还远远不够,你需要把包发布出去并让用户照着开发文档进行使用,因此,你还需要经历这些步骤:
阶段 | 工作 | 交付产物 | 能力 |
---|---|---|---|
设计版本号 | 为当前版本设计合理的版本规划 | 版本号 | / |
打包 | 要考虑到不同的引用方式和兼容性等问题 | 打包产物 | / |
发布 | 将打包产物发布到公共平台 | 平台包 | / |
文档/例程 | 为库书写良好的文档与例程 | 文档 | 文案能力 |