SuperAPI AI 工具集

readme-authoring

写作与研究

查看项目

更新于 10-16 07:59

技能介绍

用途:该技能用于创建、更新、审查或同步 README.md,让 README 回答读者的下一个问题,内容基于仓库实际功能,而非凭空编造。

主要能力:按受众区分内容,开源用户、内部同事、未来的自己和配置目录读者需求不同;主张证据优先,命令、参数、API 必须与文件或用户声明的接口一致,不虚构短别名(如 -y);强调最短可运行路径,把一条 happy-path 命令放在前面,flags 与替代安装方式放在下方;Quick Start 优先出现在首屏,交互式/零参数路径在前,非交互式在后;深度文档用链接引用而不重复;使用直接、主动的人话,不用宣传或浮夸的 AI 腔调。

使用方式:先明确任务(创建、添加章节、更新/同步、审查)、受众类型和 README 路径(monorepo 需限定分析范围)。随后从拥有该 README 的目录树中收集证据:清单/锁文件可判断包管理器、脚本和运行时要求;入口/公共导出或运行/部署命令;可交叉链接的既有文档;来自 examples、tests 或 CLI 的真实用法。若有现存 README,先给出缺口清单(缺失、过时、受众错误、Quick Start 过密),再按类型加载章节清单和模板进行草稿或补丁,同步时优先做外科手术式编辑。完成前需验证名称、what/why、用法路径齐全,安装/运行命令与锁文件/脚本/CI 一致,Quick Start 以交互/happy path 开头,示例真实或明确标注为示意,链接可解析,无虚构功能、依赖、参数或别名,并自问是否遗漏读者需要的内容。

限制:资料未提供具体模板细节、各 references 文件内容、适用平台或收费信息;该技能通过 /update-readme 这一 Cursor 包装器在更新/同步模式下调用。