用途:帮助编写、优化或审查 GitHub 开源项目的 README.md,使读者能尽快理解项目用途并开始使用。
工作流程:先确认上下文,包括项目类型(库、CLI、Web 应用或 GitHub Action)、目标读者(用户、评估者或贡献者)和 README 目标(创建、改进或审查)。再构建首屏:H1 放项目名,用一两句话说明价值,技术栈说明放在其后;提供最短的 Quickstart 路径,只保留必要链接(如文档、Issues、Releases)。
Quickstart:控制在约三到六行,顺序为 Requirements、Install、Run,只保留可实际运行的命令;较长的系统相关安装步骤移到 docs/installation.md。
结构:默认包含 Highlights、Quickstart、Usage、Documentation、Getting help、Contributing、License,详细说明移到 docs/,README 中只保留相对链接。
最终审查:确认读者能在五分钟内从发现项目到首次成功运行;检查失效链接、版本假设和过时说明。
审阅策略按优先级:Critical 包括 Quickstart 无法执行、缺少 What/How to start/Help 等必要信息、README 过大导致开始路径被埋没;Warning 包括章节顺序不符合读者决策流程、文档链接弱或难找、徽章或链接过多掩盖项目价值;Info 包括措辞可更简单、补充示例(如 CLI 或最小代码示例)、FAQ 或排障链接。
参考文件:references/readme-review-checklist.md(检查清单)和 references/readme-template.md(模板)。
限制:资料未提供具体安装命令、版本要求或完整示例代码,相关内容暂未提供。