文档管理
- 1、 文档统一放 docs 目录,按顺序依次生成文档
- 2、 所有文档都遵循渐进式披露原则——也就每个文档都不大,但是会链接到相关文档,类似于主文档里面主要就是概要和目录,具体内容链接到章节对应的小文件
- 3、 根目录有一个 README 可以方便的索引到相关文档,类似于目录
- 4、AGENTS.md 强制要求修改功能要修改相关文档,有时候人也需要定期检查一下,即使加了规则也可能遗漏
- 5、每个模块,每个功能实现,需要拆分细一点文档,完整的实现原理、核心代码、整个流程链路
- 6、项目从0到1指南文档