SuperAPI AI 工具集

repo-prettifier

通用与其它

查看项目

更新于 10-15 16:47

技能介绍

用途:把平淡或空白的 GitHub README 改写成更易被阅读、收藏和分享的页面,核心诉求是转化而非装饰。它强调 README 是披着文档外衣的说服文案。

工作方式:该技能为交互式。第一阶段静默研究仓库,阅读 README.md,并扫描 CLAUDE.md、AGENTS.md、skill/agent 文件、package.json、pyproject.toml 等关键文件,先就项目做什么、面向谁、差异点、现有 README 的不足形成自己的观点。

第二阶段定位访谈,先复述自己的理解并由用户确认,再生成 3–5 个标题/标语方向供选择,澄清受众、语气、深度、已有素材(Logo、截图、演示 GIF),询问是否生成自定义 SVG 图标;随后给出视觉风格选项(Clean minimal、Bold technical、Warm narrative 或自定义混合),并逐节确认结构后再动笔。

第三阶段决定视觉设计,包括首屏样式、徽章、表格与列表、emoji、GitHub 提示块、ASCII 树或流程 SVG 图等,均需用户确认后实施,流程 SVG 保存到 docs/assets/<repo-name>-flow.svg。

第四阶段写作,在定位与风格确认后才输出,默认交付 README2.md 供审阅,经明确确认才替换 README.md;之后可按段落迭代语气、章节或风格。

文风规则:直接、具体、以结果为导向,避免夸大词(如 powerful、revolutionary、game-changing、blazing fast,除非有基准数据),使用短句、主动语态、现在时。

推荐写作模式:强首屏(项目名、单行标语、2–4 个徽章)、先讲痛点、量化声明(如约 20 分钟产出完整 offer 系统、11 个输出文件)、视觉层级、渐进披露(满足略读者、评估者、采用者)、五分钟内可复制的快速开始、社会证明锚点、功能表格、架构清晰化、诚实定位(说明不适合谁)。

安装相关:若是 agentic skills,优先使用 npx skills add https://github.com/<usertag>/<repo>;含 agents 与 skills 时可 git clone 后执行 cp -r skills/ agents/ ~/.claude/,且不要删除 skills/ 或 agents/ 下的文件。

限制:资料未提供价格、收费模式、平台支持范围、实际效果保证或具体命令输出示例;工具为提示式技能而非 API 库,不适用于只想要填空模板的文案人员或需要代码库的开发者。其宣称的转化与传播效果属目标导向,具体成效取决于仓库本身与用户配合,未提供可验证的基准数据。