doc-gardener
文档园丁,负责知识库建立后的一切维护工作:自动巡检(过期文档、代码不一致、失效引用)、整理散乱文档、审计模块旧文档、梳理归类。当用户提到"文档巡检""文档园丁""检查文档""扫描文档""整理文档""审计文档""梳理文档"时使用。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
메뉴
文档园丁,负责知识库建立后的一切维护工作:自动巡检(过期文档、代码不一致、失效引用)、整理散乱文档、审计模块旧文档、梳理归类。当用户提到"文档巡检""文档园丁""检查文档""扫描文档""整理文档""审计文档""梳理文档"时使用。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | doc-gardener |
| description | 文档园丁,负责知识库建立后的一切维护工作:自动巡检(过期文档、代码不一致、失效引用)、整理散乱文档、审计模块旧文档、梳理归类。当用户提到"文档巡检""文档园丁""检查文档""扫描文档""整理文档""审计文档""梳理文档"时使用。 |
知识库建立后的唯一维护入口。包含三大能力:巡检、整理、审计。
所有涉及多文件、多模块的操作,必须使用 Task 工具启动子 agent 并行处理。
触发:"文档巡检" / "跑一下文档园丁" / "检查文档" / "扫描文档"
bash ~/.cursor/skills/doc-gardener/scripts/scan.sh <项目根目录>
脚本执行 13项检查:
| 范围 | 检查项 |
|---|---|
| 文档结构 | 关键文件存在、AGENTS.md行数、设计文档验证状态、索引同步、过期(>30天)、空目录 |
| 代码一致性 | 容器一致(docker ps vs 架构.md)、端口一致、凭据一致(.env vs 凭据文档)、模块目录一致、部署模式一致 |
| Git分析 | 代码变更但文档未更新的模块、文档统计 |
根据扫描结果,启动并行子 agent 分头处理:
| 问题类型 | 子 agent 任务 |
|---|---|
| 容器/端口/模块不一致 | 更新 架构.md 和 AGENTS.md 对应部分 |
| 凭据不一致 | 读取 .env 最新值,更新凭据文档 |
| 部署模式不一致 | 读取 docker-compose,更新 架构.md 标记 |
| 代码变更未同步 | 逐模块分析 git diff,判断是否需要更新文档 |
Agent 额外主动检查:
文档/ 内的 TODO/FIXME 标记执行计划/进行中/ 是否有已完成但未归档的计划AGENTS.md 知识库索引是否与 文档/ 子目录同步存入 文档/变更日志/文档巡检报告-YYYYMMDD.md。
触发:"整理文档" / "整理XX模块的文档"
当项目下有散落在各处的旧文档时使用。
第一步:扫描盘点(子 agent)
启动 1 个子 agent 递归扫描目标范围内所有 .md 文件,生成审计清单:
| 序号 | 当前路径 | 文件名 | 大小 | 最后修改 | 初步分类 | 处置建议 |
处置建议类型:迁移 / 合并 / 归档 / 废弃 / 更新后迁移
第二步:并行分类迁移(多个子 agent)
按审计清单结果,启动并行子 agent:
| 子 agent | 负责范围 |
|---|---|
| agent-A | 迁移设计文档类(补验证状态头部) |
| agent-B | 迁移参考资料类(API文档、数据库Schema等) |
| agent-C | 迁移凭据/配置类 + 产品规格类 |
| agent-D | 处理需合并/归档/废弃的文档 |
每个子 agent 的执行动作:
文档/ 对应子目录,补验证状态头部文档/执行计划/已完成/第三步:清理与更新索引
AGENTS.md 知识库索引架构.md(如发现架构信息需修正)第四步:输出审计报告
# 文档审计报告 — [范围] — [日期]
## 统计
## 发现的问题
## 新增的隐性知识
触发:"审计XX模块的文档" / "梳理XX模块"
对特定模块下的旧文档进行深度审计,验证其与代码的一致性。
第一步:定位模块文档
读取目标模块目录,找出所有 .md 文件和文档类子目录(规划文档/、文档/ 等)。
第二步:逐份验证(子 agent 并行,每个 agent 处理 3-5 份文档)
对每份文档:
第三步:分类处置
根据验证结果:
文档/ 对应子目录第四步:输出模块审计报告
| 操作 | 权限 |
|---|---|
| 架构.md 补充容器/端口 | 直接修复 |
| AGENTS.md 更新知识库索引 | 直接修复 |
| 设计文档补验证状态头部 | 直接修复 |
| 删除空目录 | 直接修复 |
| 凭据文档更新 | 修复后展示 diff |
| 部署模式标记修正 | 修复后展示 diff |
| 质量评分调整 | 修复后展示 diff |
| 过期文档处置 | 需人工确认 |
| 大范围代码-文档不一致 | 需人工确认 |
Go 语言项目的开发模式和最佳实践。当用户提到"写 Go 代码""Go 服务""Go 接口""goroutine""Go 测试"时使用。
macOS 桌面应用开发的模式和最佳实践。当用户提到"开发 Mac 应用""SwiftUI""Swift 代码""桌面应用""菜单栏应用"时使用。
创建或更新 Skill 的交互式 SOP,通过分步提问引导用户完成 Skill 设计与实现。当用户提到「创建 skill」「帮我做一个 skill」「更新 skill」时使用。
Agent 闭环自验证工作流,在完成代码修改后自动执行"写代码→构建→验证UI→查日志→修复→再验证"的完整循环。当 Agent 完成功能开发、Bug 修复、UI 修改、API 变更或任何代码改动后,应主动触发此验证流程,确保改动真正生效且无副作用。适用于 Web 前后端项目的闭环验证。
统一 AI 调用服务,三服务商策略(4sapi+sodao+OpenRouter),支持文本对话、图片理解、PDF/音视频分析、图像生成、流式输出、智能降级。当需要接入大语言模型或实现多模态 AI 功能时使用。
企微聊天记录查看方案,后端统一处理消息同步/解密/媒体下载/语音转文字,前端按业务场景分散在各模块。当需要展示聊天记录、实现会话历史查看或消息渲染时使用。