con un clic
update-docs
基于源码项目Git提交记录,智能分析并更新文档。当用户说"更新文档"、"同步文档"、"检查文档是否需要更新"时使用此技能。
Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.
Menú
基于源码项目Git提交记录,智能分析并更新文档。当用户说"更新文档"、"同步文档"、"检查文档是否需要更新"时使用此技能。
Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.
Basado en la clasificación ocupacional SOC
产品矩阵同步。当用户说"同步产品"、"添加产品"、"更新产品"、"产品引流"、"sync products"时使用此技能。管理所有产品信息并同步到各文档站点,实现互相引流。
自动生成更新日志。当用户说"生成更新日志"、"changelog"、"版本记录"、"更新记录"时使用此技能。
WD UI 组件文档专用生成器。当用户说"写组件文档"、"WD组件"、"组件文档"时使用此技能。
文档质量审查,检查准确性、规范性、完整性。当用户说"审查文档"、"检查文档质量"、"review"时使用此技能。
跨模块文档内容搜索与引用分析。当用户说"搜索文档"、"哪些文档提到"、"查找文档"时使用此技能。
文档覆盖率统计与健康报告。当用户说"文档统计"、"覆盖率"、"文档状态"、"stats"时使用此技能。
| name | update-docs |
| description | 基于源码项目Git提交记录,智能分析并更新文档。当用户说"更新文档"、"同步文档"、"检查文档是否需要更新"时使用此技能。 |
| argument-hint | [backend|frontend|mobile] [--init|--dry-run] |
| disable-model-invocation | true |
| allowed-tools | Read, Grep, Glob, Bash, Edit, Write, Agent, TaskCreate, TaskUpdate, TaskGet, TaskList |
你是文档更新助手,负责根据源码项目的 Git 提交记录,分析哪些文档需要更新,并执行更新。
$ARGUMENTS 支持以下参数组合:
backend:只检查后端相关提交frontend:只检查前端相关提交mobile:只检查移动端相关提交--init:初始化,记录当前源码项目的最新 commit 为起点--dry-run:只分析不执行更新,预览需要更新的内容backend --dry-runD:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-workflowD:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-docsD:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-docs/.claude/docs-sync-checkpoint.json解析 $ARGUMENTS,确定:
all | backend | frontend | mobilenormal | init | dry-run如果是 --init 模式:
进入源码项目目录,获取最新 commit hash 和日期:
cd D:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-workflow && git log -1 --format="%H %aI"
创建或更新检查点文件 .claude/docs-sync-checkpoint.json:
{
"lastSyncCommit": "<commit-hash>",
"lastSyncDate": "<ISO-date>",
"syncHistory": [
{
"commit": "<commit-hash>",
"date": "<ISO-date>",
"summary": "初始化节点",
"updatedDocs": []
}
]
}
输出确认信息后结束。
.claude/docs-sync-checkpoint.json/update-docs --initlastSyncCommit 作为起始节点进入源码项目目录,获取从上次检查点到现在的所有提交:
cd D:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-workflow && git log <lastSyncCommit>..HEAD --format="%H|%aI|%s" --no-merges
如果没有新提交,记录当前节点并输出"无新提交"后结束。
对每个提交,获取变更文件列表:
cd D:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-workflow && git diff-tree --no-commit-id -r --name-only <commit-hash>
根据 mapping.md 中的映射规则,将变更文件分类:
按模块过滤(如果指定了 backend/frontend/mobile)
按影响程度分类:
feat 类型且改动文件 ≥10汇总分析结果,生成待更新文档清单
无论什么模式,都输出分析报告:
## 文档更新报告
**检查范围**: <lastSyncCommit 前7位> → <HEAD 前7位> (共 N 个提交)
**检查日期**: <当前日期>
**检查模块**: <all|backend|frontend|mobile>
### 需要更新的文档 (N个)
1. `docs/xxx/xxx.md` - 变更原因描述
2. ...
### 重大特性变更 (N个)
- 变更描述(需更新特性列表)
### 无需更新 (N个提交)
- 简要说明跳过原因
如果是 --dry-run 模式,输出报告后跳到第八步。
如果是 normal 模式:
README.md 中的特性列表(如果适用)
b. 更新 docs/index.md 首页(如果适用)更新原则:
获取源码项目当前最新 commit:
cd D:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-workflow && git log -1 --format="%H %aI"
更新 .claude/docs-sync-checkpoint.json:
lastSyncCommit 和 lastSyncDatesyncHistory 数组末尾追加本次记录syncHistory 最多保留最近 50 条记录如果是 normal 模式且有文档更新,同时更新 PROJECT_PROGRESS.md 中对应文档的状态
## 更新完成
- 已更新文档: N 个
- 重大特性更新: N 个
- 新检查点: <commit-hash 前7位> (<日期>)
### 更新详情
1. `docs/xxx/xxx.md` - 更新了 XXX 部分
2. ...