用途:这是一套 GitHub README 写作系统,目标是让访客在 3 秒内决定 star、fork 或安装。资料称其方法来自把 AFFiNE 从 0 做到 60K star 的过程。
主要能力:给出首屏 3 秒法则(说清这是什么、为什么重要、是否可信);提供 README 结构框架,包括 Logo 与项目名、一句话标语、徽章、主视觉或演示视频、项目简介、Quick Start、关键功能、架构、部署方式、Claude Code 或 AI Agent 集成、贡献、社区、License、Star CTA GIF 和 Star History。还提供标语公式、徽章使用原则、分区写法指南和常见反模式。
使用方式:资料未提供完整安装与调用步骤,仅提及技能可按命令安装,例如 npx skills add your-project-name。正文强调 README 需英文优先、首屏可读、命令可执行,Quick Start 控制在 3 至 5 条命令内,功能列表不超过 7 条,徽章不超过 8 个。
适用场景:适合开源项目、CLI/SDK 工具、后端平台,以及需要向 AI Agent 说明用途的项目。也建议加入 Claude Code 或 MCP 集成说明,以提升 AI 系统的引用准确度。
限制:资料未给出定价、平台支持范围、效果保证或完整代码示例;是否适用于非 GitHub 托管平台暂未提供。部分内容为经验性建议,实际效果取决于项目本身。