农村的师傅的博客

梳理和总结下团队中的开发流程和一些我认为重点关注的细节。

作为一个npm包，文档对于其业务的引用者来说，自然是重中之重，尤其是npm包的开发者和业务的使用者不是同一个人，甚至不是同一个业务。故能有一份完善的文档，对于npm包的使用者来说是最安心不过的了。

随着业务的发展，公司开发的npm SDK业务越来越复杂，功能越来越多，以及在SDK被业务使用的过程中，也遇到一些较为棘手的问题，multirepo已经逐渐不再适用发展需求了，故尝试对SDK仓库进行改造，从multirepo转向了monorepo。

之前在公司中，我负责设计和开发过一个和音视频多人互动业务相关的业务SDK模块，该模块作为一个独立的npm包来供不同的业务层应用去使用，我从最开始的项目创建到后续的迭代优化，我一步步对这个npm包的工程化方面进行了改进，虽然每个npm包的功能都有所差异，但是其工程化方面的演进思路感觉都是有不少共通之处的。

在公司中，我开发了一个封装音视频多人互动业务的npm包，由于我开发的这个SDK项目，并非是独立的js逻辑，还包含了后台服务接口以及IM，同时其封装的业务逻辑还包含所谓的多人、多平台，故其测试的工作量和复杂性会更大。为了减少自测成本、覆盖更多的测试边界场景来高效的保障其高质量，故我引用了puppetee来完成该npm包的功能测试来实现其目的。

本次我们了解一下通常在编写node原生模块时，都有哪些方式，并简单说明一下它们的特点。

通常我们在页面访问一个静态资源（通常是get请求）比如js、css、图片等，在获取到这些静态资源后，浏览器可以根据一定的规则将资源进行缓存，以便下次再请求相同的资源时，可以直接使用缓存，而无需重复加载。

这里主要记录一下，我在我司搭建和推广前端CICD时，基于公司现有场景和业务，以及相关实践所做的一些思考和总结。

我在上一篇文章中node c++模块开发：项目搭建文章中，一步一步搭建了一个基本的node c++模块项目。但是，那个项目还存在着一些问题，比如对c++部分的测试，ts类型定义（不然用ts干啥），API文档等等。这篇文章，我将尝试解决这些问题，并对项目的配置做进一步的优化。

本篇文章思考了为什么要建立前端文档，以及用什么样的形式去建设前端文档。后续会尝试整理出针对不同类型的文档的建设方案。