SuperAPI AI 工具集

github-readme

写作与研究

查看项目

更新于 10-15 21:54

技能介绍

用途:撰写、重构、瘦身或审查 GitHub 项目 README.md,含双语 README、头部徽章、安装段、benchmark 主张与 docs/ 分流。核心原则:说人话、读者 3 秒看懂首屏、README 只回答四件事(是什么、为什么用、怎么装、长什么样)。

主要能力:区分新写、更新、瘦身、审查四类任务并给出流程;用事实清单把每条主张对应到出处(安装命令查 package.json scripts/Makefile/CLI --help,默认值查读取它的代码,版本与 License 查 manifest 与 LICENSE,测量数字查数据文件及生成命令);提供头部六层结构、徽章选择、示例表格、下载与安装段写法、双语对照规范,以及按项目形态(Agent Skill、自托管、桌面、CLI、组件库)路由的参考文件;给出终审清单与校验脚本。

使用方式:动笔前先分任务并建立事实清单,查不到出处的主张不写,仅用户知晓的信息先询问,问不到写成 <!-- TODO: ... -->;按结构顺序撰写;跑校验脚本: node <本 skill 目录>/scripts/check_readme.mjs README.md README.zh-CN.md 脚本需 Node 18 以上、无需安装依赖,其他文件名用 --pair 指定;error 必改,warning 逐条判断。新写或大改后按 references/verification-brief.md 做独立核查。

限制:README 建议约 300 行,超过 350 行瘦身;大文件、视频、GIF、benchmark 语料放到 git 外;双语须同一 commit 修改并逐项对照。资料未提供具体收费、价格、平台支持范围与效果数据。