用途
readmes 是一个用于元仓库(meta-repo)的文档维护技能,旨在对仓库内所有 README.md 文件进行全面的审查与更新,确保文档的准确性、一致性和完整性。它通过调用 technical-writer 智能体,逐项检查每个 README 的状态、日期、链接、内容结构和格式,并自动修复常见问题。
主要能力
该技能覆盖以下检查与更新项:
- 状态准确性:核对 README 中的状态是否与 CLAUDE.md 中的 Current Projects 一致。
- 日期准确性:检查“Last Updated”是否为当前日期,并更新为最新日期。
- 链接有效性:验证所有链接是否可正常工作,修复失效链接。
- 内容完整性:确认必需章节是否齐全,补充缺失章节。
- 格式一致性:检查格式是否符合标准模板,统一格式。
执行完成后,技能会输出报告,内容包括:审查的 README 数量、已更新的文件列表、以及需要人工处理的问题。
使用方式
该技能通过命令 /readmes 触发,用于审查 ideas/ 目录下的所有 README。执行流程如下:
- 发现所有 README:使用 Glob 模式
ideas/**/README.md查找文件。 - 逐个审查:对每个 README,technical-writer 智能体检查状态、日期、链接、内容完整性和一致性。
- 更新 README:修复过时状态、更新日期、修复失效链接、补充缺失章节、统一格式。
- 报告结果:汇总审查数量、更新文件列表和需人工处理的问题。
适用范围
包含:
ideas/[project]/README.md:所有项目概览。ideas/[project]/apps/*/README.md:多应用项目的 README。- 根级文档文件。
排除:
spaces/目录(代码仓库有各自的维护流程)。- 构建产物、node_modules 等。
适用场景
- 项目重大更新之后。
- 项目评审或演示之前。
- 每月文档维护。
- CLAUDE.md 中状态变更之后。
限制与注意事项
- 读取后写入:智能体在修改前会先读取每个文件。
- 保留内容:仅更新元数据和已知章节,不删除自定义内容。
- 非破坏性:不会移除自定义内容。
- 幂等性:可安全地多次运行。
集成方式
推荐流程:更新 CLAUDE.md 状态 → 运行 /readmes → 验证更改。