用途:AwesomeReadme 用于创建、改进和审查 GitHub README 文件,核心思路是“故事先于安装,钩子先于文档”,先抓住读者注意力,再提供安装与参考内容。
主要能力:按请求路由到三个工作流。Create 由“create readme、write readme、new readme”触发,对应 workflows/Create.md;Improve 由“improve readme、make readme better、rewrite readme、more compelling”触发,对应 workflows/Improve.md;Analyze 由“analyze readme、review readme、readme feedback、audit readme”触发,对应 workflows/Analyze.md。执行工作流前先用 read 工具加载对应文件。默认编辑 README.md。
推荐结构:Hero 区(标语、徽章、一句突破性说明)、问题、洞察、解决方案、效果展示(demo、截图、GIF 或代码示例)、以收益为导向的功能表、快速开始、工作原理、项目故事、页脚(路线图、贡献、许可证、行动号召)。
使用方式:用 read 工具检查 README.md、package.json、CLAUDE.md 和 docs 等文件;bash 仅用于快速查看目录或收集元数据;用普通对话提问代替 AskUserQuestion;若需要视觉内容且无图像生成或艺术技能,则生成 Mermaid 图、ASCII 图或在 docs/ 中放置清晰的图片占位符。改进结构时需保留技术准确性。
可用写作钩子:停止做痛苦的事,开始做更好的事;首个具备某独特收益的某类产品;事物可能说谎,测试或证据不会。应避免:以安装说明开头、把故事埋在最底部、先堆技术术语而无情感背景、忽略视觉层级、结尾没有明确行动号召。
限制:资料未提供收费、价格、平台、效果保证或具体使用步骤等细节;所有行为依赖工作流文件与 read/bash 工具可用。