夜雨聆风学习资料网

ARTICLE · 1121455

文档的管理我是这么做的

文档的管理我是这么做的

1. 文档统一放 docs 目录;

2. 所有文档都遵循渐进式披露原则——也就每个文档都不大,但是会链接到相关文档,类似于主文档里面主要就是概要和目录,具体内容链接到章节对应的小文件;

3. 根目录有一个 README 可以方便的索引到相关文档,类似于目录;

4. AGENTS.md 强制要求修改功能要修改相关文档,有时候人也需要定期检查一下,即使加了规则也可能遗漏;

5. 后续维护的时候,该讨论方案正常讨论方案即可,方案确认后执行的时候让 AI 同步文档。

福建,1小时前,

相关学习资料