关于 groove-work-doc
为代码库中的组件、概念或模式生成结构化参考文档的技能，面向后续接手的开发者和 Agent。它要求基于实际代码路径说明工作流程，并涵盖关键文件与注意事项。
主要功能
- 01按主题生成组件或概念文档
- 02文档包含概览、关键文件、工作原理和注意事项
- 03先研究代码库并引用实际文件路径
- 04主题含糊时先询问文档受众
- 05写入固定的 groove 文档目录
适用场景
- 01记录新贡献者需要了解的组件结构
- 02说明功能在代码中的实际执行流程
- 03整理代码中的边缘情况和约束
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/groove-work-doc确认已加载。
详细介绍
groove-work-doc
如果提供了 $ARGUMENTS，则将其用作文档主题。
预期成果
编写一份结构化文档，说明某个组件、概念或模式的工作原理，供未来接手代码库的 Agent 和人类阅读。
验收标准
文档包含：
- 概述：说明该组件或概念是什么，以及它解决了什么问题
- 关键文件：列出最重要的文件，并用一句话说明每个文件的作用
- 工作原理：分步骤说明主要流程或逻辑
- 注意事项：说明不明显的限制、边缘情况和已知问题
约束
- 清理主题名称，使其适合作为文件名：去除路径分隔符、特殊字符和路径遍历模式（
../） - 文档目录固定为
.groove/memory/docs/ - 确保文档目录存在（如果不存在则创建）
- 写作前彻底研究代码库（使用 Explore Agent）；文档应引用实际文件路径，而非泛泛描述
- 如果范围不明确，请询问用户：“受众是谁——新贡献者、未来的 Agent，还是两者兼有？”
- 在隔离的上下文中编写文档（使用通用 Agent）
- 完成前确认四个必需章节均已包含
- 每个章节都要简洁——这是参考文档，不是教程
质量参考
- “关键文件”列出在代码库中找到的实际路径
- “工作原理”追踪真实的执行路径（例如：“用户运行 X → Y 读取配置 → Z 写入文件”）
- “注意事项”指出阅读代码时不易发现的问题
- 文档不重复规范中已有的内容；如果存在规范，则链接到该规范
评论
支持 Markdown