SuperAPI AI 工具集

crafting-readme-files

写作与研究

查看项目

更新于 10-15 21:09

技能介绍

用途:为 GitHub 开源项目撰写或大幅改写专业 README.md,把 README 视为“销售说明 + 上手引导 + 参考手册”三合一文档,核心原则是先讲价值、用示例证明、精确记录。

主要能力:提供完整章节结构与模板,包括 Hero 区(插图、徽章、一句话描述、curl 安装)、TL;DR(问题、解决方案、功能表)、快速示例(5–10 条命令)、设计理念、与替代方案对比表、多种安装方式、快速开始、命令参考、配置示例、ASCII 架构图、故障排查、局限性、FAQ、贡献与许可。还给出徽章写法、对比表、架构图、可折叠区块、AGENTS.md 精简参考块等模板,以及发布前检查清单和应避免的反模式(安装优先、抽象描述、无示例、隐藏局限等)。

使用方式:资料提供了一段“EXACT PROMPT——README 修订”提示词,要求读取现有 README.md 并按 13 项结构大幅改写:先 Hero 区,再 TL;DR、快速示例、设计哲学、对比表、安装、快速开始、命令参考、配置、架构图、故障排查、局限性与 FAQ,并强调可扫读、多用表格、让每个论断都有具体示例。安装示例包含 curl 一行式与包管理器(如 brew、scoop)以及从源码构建的多条路径。

适用场景:为 CLI 工具或开源项目生成结构化、可复制粘贴的 README;也适用于对已有 README 做系统性重写,以及为 AI 代理准备精简参考。

限制:资料未提供该技能的安装命令、定价、平台支持或实际生成效果等信息,暂未提供。