SuperAPI AI 工具集

deepresearch-readme

写作与研究

查看项目

更新于 10-15 22:39

技能介绍

用途:帮助 GitHub 开源项目把 README 整理成能快速传达“能做什么”和“如何开始”的状态,支持新建、改进与评审三种目标。

主要能力:先确定项目类型(库/CLI/Web 应用/GitHub Action)、目标读者(使用者/评估者/贡献者)与 README 目的;再构建首屏,H1 写项目名,用 1~2 句先讲价值,放置 Quickstart 最短路径与必要链接(Docs、Issues、Releases)。Quickstart 按 Requirements、Install、Run 顺序压缩到 3~6 行,只保留可实际执行的命令;OS 差异较长时拆分到 docs/installation.md。

结构:基本章节为 Highlights、Quickstart、Usage、Documentation、Getting help、Contributing、License;详细说明移入 docs/,README 只留相对链接。

评审优先级:Critical 包括 Quickstart 无法执行、缺少 What/How to start/Help、README 过大导致开始步骤被淹没;Warning 包括章节顺序与读者决策顺序不符、docs 导引弱、徽章链接过多;Info 包括表达精简、补充 CLI 或最小代码示例、增加 FAQ 与故障排查导引。

使用方式:生成正文时优先使用 references/readme-template.md 模板;评审时用 references/readme-review-checklist.md 做覆盖检查。最终验证需确认 5 分钟内可完成“引入→最小运行”,并检查链接失效、前提版本与步骤过时。

限制:资料未提供具体安装命令、支持平台、收费方式或效果保证,相关内容暂未提供。