docs-sync-check

用途

docs-sync-check 用来约束“代码改了，说明也要一起改”。

它主要覆盖两件事：

• 功能目录级别的 README.md 必须存在且随代码同步更新。
• 新增或修改的 .py / .sh 文件必须包含并维护“使用方法”说明。

适用场景

• 新增脚本、命令入口或功能目录。
• 修改参数、输入输出路径、产物位置、目录结构。
• 重构后需要确认 README 与脚本说明仍然准确。

使用方式

当任务涉及代码、脚本、命令或产物路径变更时启用此 skill，并按下面顺序执行：

1. 识别受影响的功能目录。
2. 检查并更新对应目录的 README.md。
3. 检查并更新所有新增/修改的 .py / .sh 的“使用方法”说明。
4. 收尾前手动自检，确认路径、命令、参数、产物位置与代码一致。

这个 skill 不提供内置检测脚本，依赖执行者在收尾阶段手动完成一致性检查。

README 最低要求

受影响功能目录的 README.md 至少应包含：

• 功能用途
• 输入与输出
• 运行方式
• 关键参数
• 产物位置
• 本次相关变更说明

脚本“使用方法”最低要求

新增或修改的 .py / .sh 文件顶部附近应包含：

• 脚本用途
• 最小可运行命令
• 关键参数或环境变量
• 输入输出路径示例

内置文件

• LICENSE：独立开源发布使用的许可证文件。
• SKILL.md：给 AI coding agent 的执行规则、触发边界和收尾要求。
• README.md：给维护者快速理解此 skill 的用途、边界和手动自检方式。
• agents/README.md：说明界面元数据目录的职责与维护方式。
• agents/openai.yaml：给 UI/技能列表读取的发布元数据，定义显示名、简介和默认提示词。
• templates/README.md：说明模板目录的用途与维护边界。
• templates/feature-readme.md：功能目录 README 模板。

最近变更

• 2026-04-09：将 v2 draft 收敛为正式 docs-sync-check，删除内置检测脚本，仅保留规则说明和 README 模板。
• 2026-04-09：新增 agents/openai.yaml，发布该 skill 的 UI 元数据。
• 2026-04-09：补充 LICENSE、agents/README.md 和 templates/README.md，满足独立发布最小条件。