用途
update-docs 是一个在代码库发生有意义改动后运行的文档审计技能。它会检查每一个文档位置,判断哪些已经过时,并更新它们。可用场景包括完成一个功能、合并拉取请求,或任何对代码库的显著变更之后。
主要能力与使用步骤
该技能按四个步骤执行。
第 1 步:理解改动了什么
使用以下命令查看当前分支相对 master 的变更,或在工作于 master 时查看最近提交:
# Changes on the current branch vs master
git log --oneline master..HEAD
git diff --stat master..HEAD
# Or if working on master, recent commits
git log --oneline -10
用一句话概括改动,并分类为以下类型:新增命令(例如 Added outport open)、命令变更(新增标志、改变输出格式)、配置变更(outport.yml 新增字段)、基础设施(构建、CI、依赖变更)、缺陷修复(例如 Fixed registry save race condition)。
第 2 步:检查每个文档位置
逐一检查下列位置是否与当前代码一致。
- README.md:命令列表是否与 cmd/*.go 中的实际命令一致;outport.yml 示例是否匹配当前 schema;“How It Works” 部分是否反映当前分配行为;安装说明是否仍然准确。
- CLAUDE.md:架构部分中的包描述是否匹配当前代码;CLI 命令列表是否包含 cmd/*.go 中的所有命令;关键设计决策是否反映当前行为;开发命令是否覆盖 justfile 中新增或变更的 recipe。
- cmd/init.go 预设:服务预设切片是否包含所有标准服务;预设字段是否使用当前配置字段名。
- .goreleaser.yml:构建目标平台是否与文档描述一致;Homebrew formula 的 tap 配置是否为最新。
- docs/(VitePress 站点):docs/reference/commands.md 是否列出 cmd/*.go 中所有命令;docs/reference/configuration.md 是否覆盖所有 outport.yml 字段;docs/guide/getting-started.md 是否反映当前工作流;docs/guide/examples.md 的示例是否使用当前配置语法;docs/guide/tips.md 的排错提示是否仍然准确。
- skills/outport/SKILL.md:这是用户下载并安装到自己项目中的 Outport 技能,位于仓库根目录的 skills/outport/SKILL.md,而不是用于 Claude Code 内部技能的 .claude/skills/。需检查 Quick Reference 命令是否列出所有命令;Common Tasks 部分是否覆盖当前能力;触发关键词是否覆盖所有功能。
第 3 步:报告发现
以表格形式呈现,只显示需要关注的项,例如:
| Status | File | What needs updating |
|--------|------|---------------------|
| STALE | README.md | Commands list missing `open` |
| OK | CLAUDE.md | — |
第 4 步:进行更新
对每个 STALE(过时)项更新对应文件,规则如下:
- 不要重复内容。README 是面向用户的概览,CLAUDE.md 是面向智能体的架构指南,不要在两者之间复制内容。
- README 应描述命令做什么,而不是如何实现。
- CLAUDE.md 应描述架构与约定,而不是面向用户的文档。
按变更类型对应更新项
- 新增命令:必须更新 README 命令、CLAUDE.md 命令、docs/reference/commands.md、skills/outport/SKILL.md;视情况检查 init 预设、docs/guide/getting-started.md、docs/guide/tips.md。
- 配置 schema 变更:必须更新 README 配置示例、CLAUDE.md 配置描述、docs/reference/configuration.md;视情况检查 init 预设、docs/guide/examples.md。
- 新增约定:必须更新 CLAUDE.md。
- 基础设施:视情况检查 CLAUDE.md 开发命令。
- 缺陷修复:视情况检查 README(如记录了 workaround)与 docs/guide/tips.md。
适用场景与限制
该技能面向使用 Outport 项目结构、以 git 为版本控制、并维护 README、CLAUDE.md、VitePress 文档站点与 skills/outport/SKILL.md 的仓库。其检查项和更新规则针对该仓库的具体文件布局。资料未提供其他平台支持、依赖环境要求或收费信息。