外观
增量更新
机制
源码仍在 maodo;技术知识只维护在 maodo-wiki。src/.wiki/source-map.json 是影响范围索引,不保存第二份正文。脚本只读源码 Git,输出候选文档,不改源码、不自动改文档。
sh
npm run docs:impact -- --repo ../maodo-yufan --from <旧提交> --to <新提交>命令使用两个提交之间的实际差异,包含重命名前后的路径;不使用三点比较。未提交文件会单独提示。需要在工作区已存在的 maodo 仓库中执行,无需连接生产环境。
更新步骤
- 固定旧、新提交;查看脚本列出的候选与未覆盖路径。
- 对照具体 diff 和调用方,判断职责、接口、状态、数据归属或行为是否变化。
- 只修改受影响章节;纯格式变化可以记录“无文档影响”。
- 扩散到依赖模块时补充索引。跨模块影响无法仅靠路径穷尽,必须审阅调用关系。
- 记录源码依据、核实方式和未决问题,再检查链接和构建。
- 只有完成相应文档核实后才推进该文档的基线。一次分析不代表全部文档都核实至新提交。
初版索引覆盖五模块及部分外部接缝。未匹配文件不是“无影响”,应人工分流;OEM 未独立分析。测试文件变化也可能改变已记录行为。