用途:为软件项目或文档仓库生成首页 README,核心目标是让读者在 30 秒内知道项目是什么、去哪里找关键入口、如何最短路径使用。
主要能力:按价值门槛裁剪章节,只保留能提供其他章节所无新决策信息的部分;对项目类型分流,区分代码/应用仓库(code)与文档/规范仓库(doc);执行 anti-fluff 规则,每个主张须落到具体文件路径、shell 命令、可观测行为或明确约束。
用法:默认骨架为标题加一句话说明、核心入口/如何使用、License 三节必须保留,其余(功能列表、安装、快速启动、配置说明、贡献指南、作者致谢)按门槛决定。项目类型已知直接生成;不明时先看仓库结构(package.json、pyproject.toml、Dockerfile、INDEX.md 等)推断,不确定则询问。用户未提供描述时从仓库名与结构推断最保守描述并标 TBD。写文件前默认直接写入 README.md,若已有 README 须先提示覆盖并等待确认。doc 类型默认不生成安装与快速启动节,改为导航索引。
适用场景:新建仓库补首页文档;跨服务统一 README 风格;为遗留系统补最小信息入口;项目移交或公开发布前整理首页。触发信号为“帮我写 README”“生成自述文件”或直接提供仓库路径。
限制:禁止臆造命令、路径、功能,缺失用 TBD 或省略;禁止损坏链接,外部链接仅在高度稳定时使用;禁止空壳章节;License 节不可省略,未提供时写 TBD;doc 类型硬性不生成安装/快速启动节,即使被要求也应说明理由。生成后按 8 项自检:30 秒测试、无空泛形容词、无臆造、无损坏链接、无空壳章节、License 节存在、项目类型匹配、价值门槛通过。