SuperAPI AI 工具集

docs-keeper

通用与其它

查看项目

更新于 10-16 05:02

技能介绍

用途:docs-keeper 用于维护项目文档,区分人类与智能体(agent)两个写作区,并在多步工作前通过规划流程推进。适合初始化新项目、审计现有文档、创建计划、记录智能体会话。

主要结构:项目根目录放 README.md(面向人类,含安装、使用、状态)、AGENTS.md(项目专属 agent 指令,技术栈、命令、约定、注意事项,控制在 150 行内)、CLAUDE.md(始终是指向 AGENTS.md 的符号链接,用 ln -sf AGENTS.md CLAUDE.md 创建)。人类区 docs/*.md 由人类撰写维护,agent 只读,除非明确要求;包括 ARCHITECTURE.md(高层设计,描述能力与领域概念,不写文件路径)、ADR、API 指南、上手文档。agent 区 docs/agents/ 由 agent 撰写并提交 git,包含 PLAN.md(活计划)、ASSUMPTIONS.md(行动前记录假设,随确认或推翻更新)、notes/ 下按 YYYYMMDD-HHMM-slug.md 命名的会话笔记。

规划流程:多步工作前先创建或更新 PLAN.md。规划前先理解:阅读现有文档、代码和近期提交;一次一个澄清问题,弄清目的、约束与成功标准;提出 2-3 种方案及权衡与推荐;按复杂度分节呈现设计并逐节获批;设计获批后写入 PLAN.md,此前不写代码。计划格式要求每个任务是一个 2-5 分钟的动作,写明精确文件路径、完整代码、精确命令与预期输出。

执行方式:按批执行(每批 3 个任务),逐步遵循、运行验证;每批后汇报、展示验证输出并等待反馈;遇到阻碍、计划缺口或验证反复失败就停下询问,不要猜测。会话纪律:开始读 PLAN.md 与 AGENTS.md,结束前在有变化时更新计划、有收获时写笔记。作为 docs-keeper 被调用时:确保结构存在、审计文档与代码是否一致、修复 agent 区(人类区需授权)、标记需人工关注项、保持 AGENTS.md 精简。

限制:人类区文档不得在未获明确许可时编辑;AGENTS.md 应保持 150 行以内,超出移到 docs/;描述能力而非文件路径。资料未提供该 skill 的安装方式、收费或平台支持信息。