创新方案
代码或功能变更后,将文档写入正确文档层并避免重复或越层更新
需要为当前代码或功能更新仓库文档,并让 MDX、Agent rules、README 各归其位时使用。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 49/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 85/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 60/100 ×0.15
适用场景
代码或功能变更后,将文档写入正确文档层并通用
解决思路
- 记录当前代码或功能。
- 遵循消费该文档的仓库中的 docs 和 README 规则。
- 除非用户要求,否则不要 commit。
- 将持久的信息架构放入现有 MDX;不要发明第二套 sitemap。
- 将文档写入拥有该变更的层:技术文档(路径见 AGENTS.md)负责架构、ADRs、how-to;当行为、架构、命令、约定或工作流改变时更新。
- Agent rules 负责短约束;当 agent 必须不违反的约定改变时更新。
- 最近的 README 负责如何运行该 app/package;仅放链接;当脚本、setup 或包用途改变时更新。
- 仅当代码否则会误导时,才添加 inline comments。
- 不要将 MDX 复制到 rules 或 READMEs 中。
- 不要用 `@` 附加 MDX。
- 识别匹配的 docs section,然后找现有 topic page;仅当没有合适页面时才创建页面。
- 如果 canonical explanation 改变,写或 patch MDX。
- 仅针对 run/setup/scripts 修改 README;链接 MDX。
- 仅当约束改变时,patch 由 glob 匹配的 rule。
- 对于机械文件或文档移动:提出最小的 from/to 列表,按相关文件分组;在组内去掉文件夹名前缀。
- 仅在用户给出路径时保存。
- 除非用户也要求实现,否则不要移动文件。
适用边界 · 注意事项
- 任务不是为当前代码或功能更新文档时,不适用。
- 用户未要求提交时,不要 commit。
- 用户未要求实施文件移动时,不要移动文件。