用途:在任意项目或包中创建、更新、审计 README.md,使文档与代码库保持一致。适用于新建 README、代码变更后更新、把稀疏文档扩充为完整指南,以及 monorepo 子目录文档。不适用于 API 文档生成、变更日志、内部开发笔记和非 Markdown 文档。
主要能力:从 README 所在位置分析代码;并行发现入口点与公共 API、依赖与配置、示例与用法、现有文档;与现有 README 对比,识别缺失导出、过时示例、缺失章节和错误命令;生成含可复制命令与实用示例的内容。
使用方式:先定位 README 范围,检查 openspec/config.yml、ARCHITECTURE.md、AGENTS.md 或 CLAUDE.md 等关联文档;有子代理时并行发现,否则按序内联执行;合并外部 findings 与扫描结果并向用户展示;按模板生成或更新。根据锁文件选择包管理器:pnpm-lock.yaml 用 pnpm install,package-lock.json 用 npm install,yarn.lock 用 yarn,bun.lockb 用 bun install。超过约 200 行时在标题区后、安装章节前加目录。
限制:只记录通过包入口点可访问的公共 API,不记录未导出的内部函数;示例必须取自测试文件、JSDoc 或 examples/ 目录,不得编造;必须对照现有 README,避免文档漂移;最终文字润色依赖 accelint-english-manager,若不可用需停止并提示用户安装,调用时使用严格 audit+rewrite 模式并直接采用改写结果。具体模板与结构细节见其 references 文件。