SuperAPI AI 工具集

make-readme

写作与研究

查看项目

更新于 10-16 05:50

技能介绍

用途:当用户要求创建、生成或编写项目 README 时使用,为任意项目生成 README.md。

主要能力:先扫描工作目录识别项目上下文,例如查找 package.json、pyproject.toml、Cargo.toml、go.mod 以提取项目名与版本作为默认值;检测已有 README.md 并在覆盖前警告;识别主语言;若发现 3 个以上子清单(如 /.claude-plugin/plugin.json、/package.json)则预选 Plugin Collection。随后通过 AskUserQuestion 进行访谈:第一轮询问项目类型(Library/Package、CLI Tool、Web App/API、Desktop App、Plugin Collection)、语言(Python、JavaScript/Node、Go、Rust)、深度(Minimal、Standard、Comprehensive)与许可证(MIT、Apache-2.0、GPL-3.0、无)。若深度为 Minimal 则跳过第二轮;否则第二轮询问章节、附加内容、徽章与样式(Simple、Centered、Styled)。

生成结构:Minimal 含标题与标语、描述、安装、用法、许可证五节;Standard/Comprehensive 按所选章节组装,可含组件目录表、目录、功能、演示、配置表、API 参考、贡献、路线图、FAQ、致谢等。Styled 样式为每个 H2/H3 加 emoji 前缀,并在标题前加 <a id="slug"></a> 以稳定锚点。徽章 URL 参考 references/badges.md;版本徽章示例:v{VERSION}。

使用方式:在项目目录中触发该技能,按提示回答问题,技能将写入当前工作目录的 README.md;若已存在会先确认覆盖。完成后输出摘要,列出文件路径、包含章节及需用户替换的占位值(如 USER/REPO、PKG、工作流文件名、截图/GIF 路径等)。

限制:资料未提供具体收费、价格、平台支持范围或效果保证;生成内容依赖用户输入与检测到的清单文件,未检测到清单时需完全依赖用户输入。