知识库维护指南
本文件只规定知识库怎么维护:新增、废弃、优化、校验和定期整理。
运行时怎么调用知识库,不写在本文件里。项目经理 Agent 和各 skill 的读取顺序、权限边界、raw 读取规则,统一看 知识库调用规则。
1. 维护边界
2. 新增资料
| 步骤 | 动作 | 结果 |
|---|
| 1 | 把原始文件放进 raw/ 对应目录 | 保留可信原文 |
| 2 | 更新 原始资料清单 | 知道新增了什么 |
| 3 | 如果是 DSL,更新 DSL自动提取摘要 | 提取节点、输入、工具 |
| 4 | 提炼到对应 wiki 页面 | 变成助手能使用的结构化知识 |
| 5 | 如果有必须执行的要求,写入 硬性规则清单 | 生成和测试时强制执行 |
| 6 | 更新 index.md | 保证入口能找到 |
新增资料不要直接写进 wiki,必须先放 raw。
3. 废弃资料
| 步骤 | 动作 | 原因 |
|---|
| 1 | 不删除 raw 原文 | 保留历史证据 |
| 2 | 在关系索引里标记“废弃” | 避免助手继续复用 |
| 3 | 在对应案例卡写明废弃原因 | 方便追溯 |
| 4 | 如果是硬规则废弃,要注明替代规则 | 防止校验口径混乱 |
废弃不是删除,而是标记不能再用。
4. 优化知识页
5. raw 维护规则
| 规则 | 说明 |
|---|
| raw 只追加 | 原始 DSL、规范文档、附件原文不覆盖 |
| raw 不总结 | 总结和提炼放到 wiki 或 relations |
| raw 不删除 | 废弃资料通过关系索引标记,不直接删除 |
| raw 可核对 | 案例卡、硬规则、测试样例有争议时回 raw 核对 |
6. wiki 维护规则
| 规则 | 说明 |
|---|
| wiki 放结构化知识 | 只放助手可直接使用的解释、案例、样例和说明 |
| wiki 不放硬规则原文 | 必须执行的约束进入 rules |
| wiki 要保留来源 | 关键结论应能追溯到 raw 或 relations |
| wiki 可迭代 | 每次执行、测试、验收后都可以补充经验 |
7. rules 维护规则
| 规则 | 说明 |
|---|
| rules 只放必须执行的规则 | 不放背景介绍和案例故事 |
| 规则要有来源 | 必须注明来自哪份规范或验收要求 |
| 规则变更要谨慎 | 影响输入、执行、输出、验收的规则变更要同步通知调用规则 |
| 冲突不合并 | 如果新旧规则冲突,先标记冲突,不直接覆盖 |
8. 关系索引维护规则
9. 最小维护节奏
| 频率 | 做什么 |
|---|
| 每次新增 DSL | 更新 raw、原始资料清单、机器摘要、关系索引 |
| 每次 DSL 验收后 | 更新测试样例、失败原因、案例卡 |
| 每次规范变化 | 更新 raw、wiki、硬性规则 |
| 每批任务后 | 清理关系索引里“待确认”的内容 |
10. 维护自检
| 检查项 | 通过标准 |
|---|
| 入口可达 | index.md 能找到新增或修改的内容 |
| 来源可追溯 | wiki、rules、relations 能追溯到 raw 或明确来源 |
| raw 未被破坏 | 原始资料没有被覆盖、删除或改写 |
| 调用规则未混入维护细节 | 知识库调用规则 只保留运行时读取规则 |
| 维护指南未混入调用细节 | 本文件不写各 skill 的运行时读取表 |