用途:帮助维护者撰写或优化 GitHub 开源项目的 README,让读者快速理解项目做什么、为什么有用、如何开始使用。适用于库、CLI、Web 应用或 GitHub Action 等类型项目,面向使用者、评估者或贡献者。
主要能力:按固定工作流处理 README。先确认上下文(项目类型、目标读者、目标是创建/改进/审查);再构建首屏,包括 H1 项目名、一两句话说明价值、最短 Quickstart 路径和必要链接(Docs、Issues、Releases);Quickstart 保持约三到六行,顺序为 Requirements、Install、Run,只保留可实际运行的命令,系统相关长步骤移到 docs/installation.md;默认结构为 Highlights、Quickstart、Usage、Documentation、Getting help、Contributing、License,详细说明放 docs/ 并只留相对链接;最后做终审,确认读者能在五分钟内完成首次成功运行,检查失效链接、版本假设和过时说明。
使用方式:起草时优先使用 references/readme-template.md 模板;审查时按优先级给出发现,Critical 包括 Quickstart 无法执行、缺少 What/How to start/Help、README 过大导致入口被埋没;Warning 包括章节顺序不符合读者决策流、文档链接薄弱、徽章或链接过多掩盖价值;Info 包括措辞可简化、补充 CLI 或最小代码示例、增加 FAQ 或故障排查链接。覆盖检查可参考 references/readme-review-checklist.md。
限制:资料未提供具体安装命令、平台支持范围、收费方式或效果保证,相关事实暂未提供。