SuperAPI AI 工具集

docs-management

写作与研究

查看项目

更新于 10-15 10:59

技能介绍

用途

docs-management 是一个项目知识库引擎,用于持续维护项目中的 docs/ 目录,使其成为一个可查询、可持续更新的活知识库。其核心思路来自 Karpathy 的 LLM Wiki 观点:维护知识库最累的不是阅读和思考,而是记账——交叉引用、一致性维护,而这正是 LLM 擅长的。

三层架构

  • Raw Sources(原始素材):代码、git log、会议记录、外部文档等。
  • Wiki(知识库):docs/ 目录下所有结构化文档。
  • Schema(规则):CLAUDE.md 中的文档规范。

五个核心操作

1. Ingest(摄入)

新信息进来时,不只是新建文件,而是先搜索 docs/ 中是否已有相关文档:有则更新已有文档并合并新信息,无则创建新文档;随后更新 docs/ 内部相关交叉引用,并更新 INDEX(如有)。触发时机包括:task-manager 标 done 时(复盘完成后自动触发)、新的设计决策产生时、外部信息需要整合到项目文档时。

Ingest 中还包含对 spec 偏差的处理规则:

  • 细节偏差(字段名调整、参数变更、实现细节微调):直接更新 spec 中的技术方案章节。
  • 方案偏差(换了实现路径,但目标不变):更新 spec 技术方案,并在决策章节补注“实际执行偏差及原因”。
  • 方向偏差(目标或范围发生变化):写 decision 记录完整复盘,spec 中标注“已被 decisions/xxx 覆盖”。

2. Query(查询)

docs/ 被定位为项目的可查询知识库,而不是文件堆。触发时机包括:用户询问“这个模块之前怎么设计的?”或“上次类似问题怎么解的?”,以及 task-start 对焦阶段检索历史经验。执行流程为:在 docs/ 中搜索相关文档(specs/ 设计方案、decisions/ 踩坑记录和经验、plans/ 历史开发计划、tests/ 测试用例、guides/ 开发指南),综合相关文档给出回答;如果回答有价值且不在现有文档中,则通过 Ingest 回写 wiki。

3. Lint(健康检查)

定期体检,防止文档腐烂。触发时机包括:用户主动要求检查、大批量代码改动后、定期维护。检查清单覆盖以下项目:

  • 引用有效性:文档中引用的文件路径是否存在。
  • 进度一致性:plan 的 checklist 和实际代码是否一致。
  • INDEX 同步:INDEX.md 和实际文件是否对得上。
  • 跨文档一致:plan 引用的 spec 是否存在。
  • 状态同步:backlog 状态和实际进度是否匹配。
  • 孤立文档:有没有不被任何 INDEX 或文档引用的文件。
  • 过期内容:文档描述的代码结构是否还存在。
  • 全局视图同步:architecture/ 和 user-guide/ 的 INDEX 与实际子文档是否一致。
  • 记忆巡检:memory 中的条目是否仍然有效。

输出为“Docs 健康检查报告”,包含概况(扫描目录、文档总数、发现问题数)与问题清单表格(级别、文件、问题、建议)。

4. Index(索引维护)

索引是知识库的入口,必须和实际内容同步。维护对象包括 docs/backlog/INDEX.md(需求索引,已有,由 task-manager 维护)与 docs/decisions/INDEX.md(经验索引,待建,按时间倒序)。INDEX 更新时机:新建文档后、文档状态变更后、Lint 发现不一致后。

5. Synthesize(聚合)

从碎片文档中维护全局视图索引,重点不是写长文档,而是保持索引准确。维护对象包括:

  • docs/architecture/:INDEX.md 负责模块列表、模块间关系、核心数据流概览,每个模块一份架构文档。
  • docs/user-guide/:INDEX.md 负责功能目录、快速入门导航,每个功能/模块一份用户指南。

触发时机与模式:用户手动要求时执行全量模式(token 成本高);task-finish 提醒后用户确认时执行增量模式(只读本次变更涉及的模块,token 成本低);Lint 发现 INDEX 和实际文件不一致时执行修复(对齐 INDEX 和实际文件列表,token 成本极低)。增量模式中会判断是否涉及新模块或模块间关系变更,若是则更新对应子文档和 INDEX,否则跳过。

与其他技能的关系

  • task-finish(复盘产出)→ docs-management.Ingest(整合到知识库)。
  • task-finish(提交时)→ 提醒:是否需要 Synthesize(涉及新模块/模块间交互变更?)。
  • task-start(对焦阶段)→ docs-management.Query(检索历史经验)。
  • task-manager(需求管理)→ docs-management.Index(维护 backlog INDEX)。
  • 定期/用户主动 → docs-management.Lint(健康检查)。
  • 用户主动/Lint 发现不一致 → docs-management.Synthesize(聚合全局视图)。

与 writing 的区别:writing 负责生产文档(从无到有写出来),docs-management 负责维护文档(确保已有文档保持健康和可用)。与 task-manager 的区别:task-manager 专门管 backlog(需求的收集/排序/清理),docs-management 管整个 docs/ 目录(包括 backlog 之外的 specs/plans/decisions/ 等)。

限制

关于该技能的安装方式、运行环境、收费与价格、具体平台支持等信息,资料中暂未提供。