📌 Skill基础信息
Skill名称:document-release
简称:文档发布管理
来源:社区第三方(onlypfachi/chief)
运行宿主:Claude-Code CLI
核心定位:在代码提交后、PR合并前自动更新项目文档,确保所有文档文件与已发布代码保持同步,适用于项目发布后的文档维护场景。
🧩 内部核心组成
该Skill通过系统化的文档审计和更新流程,包含以下核心组件:
子Agent能力集合
- 文档差异分析Agent:分析git diff和代码变更
- 多文档类型审计Agent:分别处理README、ARCHITECTURE、CONTRIBUTING等文档
- 变更决策Agent:判断自动更新或需要人工确认的修改
- 版本管理Agent:处理VERSION文件更新决策
斜杠命令
| 命令名 | 功能简述 |
|---|---|
/document-release | 主工作流命令,启动完整文档更新流程 |
MCP工具依赖
- Bash:执行git命令和文件操作
- Read/Write/Edit:文档读写编辑
- Grep/Glob:文件搜索和模式匹配
- AskUserQuestion:关键决策时请求用户确认
目录结构影响
- 审计所有.md文档文件(除.git、node_modules等目录)
- 特别关注:README.md、ARCHITECTURE.md、CONTRIBUTING.md、CLAUDE.md、CHANGELOG.md、TODOS.md、VERSION
🛠 安装与启用方式
安装命令:
skills install --user onlypfachi/chief
前置依赖:
- git命令行工具
- GitHub CLI (gh) - 用于PR描述更新
- 有效的git仓库环境
启用方式:
在功能分支(非主干分支)执行 /document-release 命令
运行要求:
- 必须在功能分支运行(不能基于主干分支)
- 需要代码已提交(post-ship状态)
- PR已存在或即将创建
📋 标准工作流
- 分支验证:确认当前处于功能分支,非主干分支
- 差异分析:通过git diff分析代码变更范围和类型
- 文档发现:扫描项目中的所有.md文档文件
- 分类审计:按文档类型分别进行内容审计:
- README.md:功能描述、安装说明、示例验证
- ARCHITECTURE.md:架构图、组件描述一致性检查
- CONTRIBUTING.md:新人引导流程验证
- CLAUDE.md:项目结构、命令准确性检查
- 自动更新:对明确的事实性变更直接修改
- 人工确认:对风险变更通过AskUserQuestion请求确认
- CHANGELOG润色:仅调整措辞,绝不重写历史记录
- 跨文档一致性:检查不同文档间的引用一致性
- TODO清理:标记已完成的TODO项,收集新的延期工作
- 版本管理:版本号更新决策和执行
- 提交推送:生成文档更新commit并推送到PR
⚠️ 关键限制、缺陷、注意事项
平台限制:
- 仅支持git管理的项目
- 依赖GitHub CLI进行PR描述更新
- 必须在功能分支运行,不支持主干分支直接操作
Token消耗:较高,需要读取和分析多个文档文件内容
适合项目类型:
- 中大型项目 with 完善文档体系
- 频繁迭代的开源项目
- 有多人协作的团队项目
不适合项目类型:
- 小型或个人项目(文档简单)
- 文档极少的工具类项目
- 非git版本控制的项目
已知坑点:
- CHANGELOG.md必须使用Edit工具(不能用Write),否则会覆盖历史记录
- VERSION文件更新必须人工确认,无法自动完成
- 需要确保所有文档文件都能从README或CLAUDE.md链接到达
生产环境适用性:✅ 可用于生产环境,但需要充分测试文档更新逻辑
✅ 适用场景 & ❌ 不适合场景
适合使用:
- PR合并前的文档最终检查
- 项目发布后的文档同步
- 多文档项目的 consistency 维护
- 团队协作中的文档质量保障
不适合使用:
- 初始项目文档创建
- 完全重写文档结构
- 单一文档的小型项目
- 无需版本管理的临时项目
如何安装
skills install --user onlypfachi/chief通用安装教程:在哪里输入上面的命令
上面的命令本质是在「终端 / 命令行」中调用技能管理器,把该 Skill 下载并注册到你的 AI 工具。各主流工具打开终端的位置不同,按下面操作即可:
- 打开工具自带的终端面板,或系统终端(macOS「终端」、Windows「PowerShell」、Linux「Terminal」)。
- 把上面的安装命令复制进去,回车运行,等待下载与注册完成。
- 重启或重新加载 AI 工具,让新安装的 Skill 被识别。
- 新建对话并触发:直接描述用途,或通过该工具的技能 / 斜杠菜单选中此 Skill。
Claude 桌面版(macOS / Windows)
桌面版没有内置命令行,Skill 需通过 Claude Code CLI 安装。打开系统终端,先执行 npm install -g @anthropic-ai/claude-code,再运行上面的安装命令;完成后完全退出并重新打开 Claude。
Claude Code(终端 CLI)
直接在项目目录的终端里运行上面的命令即可。也可先输入 claude 启动交互界面,再在对话中引用该 Skill(/ 斜杠菜单或直接描述用途)。
VS Code(含 GitHub Copilot)
打开终端面板:菜单「终端 → 新建终端」,或快捷键 Ctrl+`(macOS 为 ⌃+`)。在终端里运行上面的命令;装完后执行「重新加载窗口」(Ctrl+Shift+P → Reload Window),让 Copilot 等扩展识别新技能。
Cursor
底部「终端」面板(Ctrl+`)即是内置终端。粘贴运行上面的命令,完成后在命令面板执行「Reload Window」刷新,再开始对话。
Windsurf
底部「终端」面板运行命令;也可直接使用其内置 Agent 终端,在对话侧执行安装。
其他工具(ChatGPT、本地脚本等)
不支持本地终端的产品,可先在本机终端完成安装,再在对话中描述该 Skill 的能力让其调用;不同工具的命令格式请以其官方文档为准。
风险提示
自动扫描未发现高危命令、隐私抓取或数据外传行为。仍建议安装前快速浏览仓库代码。
Aitishiku.com