SuperAPI AI 工具集

readme-standard

通用与其它

查看项目

更新于 10-16 03:06

技能介绍

用途:这是一个 README 规范技能,用于在编写或审查 steipete、openclaw 组织公开 README 之前加载。参考实现为 openclaw/fs-safe,不确定好 README 的标准时可先阅读其 README。

主要能力:给出统一结构主线,要求按顺序回答“这是什么”(陌生人能懂的一句话)、“如何使用”(最小真实安装加能证明卖点的快速开始)、再逐步加深复杂内容,深层参考材料移到 docs/ 或文档站并链接。

结构模板:标题加一个 emoji 与一行俏皮标语;徽章行;1–2 句平实说明是什么、给谁用;可选一段不超过 10 行、能体现核心价值的小示例;随后依次为 Install、Quick start、2–6 个核心章节、Development、License。

规则:标题语气可俏皮,正文保持平实;避免超过 6 条的功能堆砌、changelog 式表述(如“现在支持”“3.2 新特性”“即将推出”);工具或库建议不超过 250 行、大而全的界面不超过 350 行;超出内容移入 docs/ 并链接;截图/横幅保留现有项目素材,应用与 TUI 在顶部附近放一张截图,压缩且不超过 500 KB;有文档站时 README 只作为入口,链接而不复制。

徽章:flat-square 风格且始终动态,不硬编码版本到 img.shields.io/badge 网址;顺序为 CI、版本、平台/运行时、许可证、附加项;按生态选择 npm、GitHub release、运行时、许可证、Homebrew 徽章;使用仓库真实工作流文件名与默认分支,上线前确认每个徽章网址可正常渲染。

各类型模板:CLI 工具、npm 库、Swift 包、macOS 应用、Web 服务或站点分别给出对应章节安排。验证门槛为强制项:README 中每条命令都要能运行;每个代码示例要能编译或类型检查;相对链接要指向仓库文件、外链不能 404、徽章要能渲染;版本信息需动态或保持最新;被移除的事实内容应已在 docs/ 中存在、在同一次 PR 中迁移,或确已过时并在 PR 说明。

限制:资料未提供该技能的具体安装命令、收费方式或适用平台信息。