用途:帮助 GitHub OSS 项目在短时间内把 README 整理到能让读者快速了解「能做什么」和「如何开始」的状态。
主要能力与流程:先确定前提(项目类型如库、CLI、Web 应用、GitHub Action;目标读者如使用者、评估者、贡献者;README 目标是新建、改进还是评审)。再组织首屏:H1 写项目名,用一到两句先讲价值而非技术栈,放置通往 Quickstart 的最短路径,仅保留必要主要链接(Docs、Issues、Releases)。随后把 Quickstart 压缩为 Requirements、Install、Run 顺序的 3 到 6 行,只保留可实际执行的命令;OS 差异过长时拆到 docs/installation.md。正文段落建议为 Highlights、Quickstart、Usage、Documentation、Getting help、Contributing、License,详细说明移入 docs/,README 仅保留相对链接。最后做验证:确认 5 分钟内能走完「安装到最小运行」,检查链接失效、前提版本与步骤是否过时,并用 references/readme-review-checklist.md 逐项核对。
使用方式:生成 README 正文时优先使用 references/readme-template.md 模板;评审现有 README 时按优先级处理,Critical 为 Quickstart 不可执行、缺少 What/How to start/Help 等必要信息、README 过大导致开始步骤被淹没;Warning 为章节顺序与读者决策顺序不符、指向 docs 的导流失效、徽章与链接过多掩盖价值;Info 为精简表达、补充示例(CLI 执行例、最小代码例)、增加 FAQ 或故障排查入口。
限制:资料未提供安装命令、支持的平台、收费与价格等信息,暂未提供。