Guide Recap 是一个内容生成工具,主要用途是从项目根目录的 CHANGELOG.md 文件中提取版本更新条目,并将其转换为面向社交媒体的发布内容。它默认生成 8 份输出,即 4 种格式(LinkedIn、Twitter/X、Newsletter、Slack)与 2 种语言(法语、英语)的组合。
用途与适用场景
该工具适用于以下场景:在使用 /release 发布版本后,准备社交媒体的发布公告;每周汇总多个版本的更新内容;在发布到 LinkedIn、Twitter/X、Newsletter 或 Slack 之前生成内容草稿。
使用方式
通过命令调用,支持以下输入模式:
- /guide-recap latest:获取最新发布的版本
- /guide-recap v3.20.5:指定具体版本
- /guide-recap week:获取当前周(周一至今天)的更新
- /guide-recap week 2026-01-27:获取指定周(周一至周日)的更新
支持的参数标志:
- --interactive:引导模式,可选择角度、受众和亮点,默认为关闭(自动起草)
- --format=X:指定单一格式,可选 linkedin、twitter、newsletter、slack,默认为全部 4 种
- --lang=X:指定单一语言,可选 fr、en,默认为法语和英语
- --save:将输出保存至 claudedocs/social-posts/,默认为仅显示
- --force:即使只有维护类条目也生成,默认会跳过低分内容
工作流程
工具包含 7 个步骤:第一步解析输入参数以确定模式和目标;第二步从项目根目录读取 CHANGELOG.md 并提取条目,支持单版本或周范围;第三步对条目进行分类,类别包括 NEW_CONTENT(权重 3)、GROWTH_METRIC(权重 2)、RESEARCH(权重 1)、FIX(权重 1)、MAINTENANCE(权重 0);第四步将技术语言转换为用户价值,提取具体数字并标注来源;第四步 b(仅 --interactive 时)展示候选亮点并询问角度、受众和主要亮点;第五步对条目进行评分并选取前 3-4 条,得分最高者作为钩子行;第六步按请求的格式和语言从模板生成内容;第七步输出内容,若指定 --save 则写入文件。
评分公式涉及类别权重、是否包含数字、是否标注来源、是否为新文件、影响文件数及是否为破坏性更新等因素。若所有条目得分低于 3,工具会提示不推荐生成社交内容,除非使用 --force。
格式与链接
生成内容时会根据格式选择不同链接目标:LinkedIn 使用落地页 URL,Twitter 使用 GitHub 仓库 URL,Newsletter 同时使用两者,Slack 使用 GitHub 仓库 URL。落地页为 https://florianbruniaux.github.io/Codex-ultimate-guide-landing/,GitHub 为 https://github.com/FlorianBruniaux/Codex-ultimate-guide。
错误处理
工具处理多种错误情况:无参数时显示用法说明;参数无效时显示用法及示例;版本未找到时列出最近 5 个版本并建议最新版;周范围无条目时显示最后发布日期并建议对应版本;全部为维护条目时提示不推荐生成;CHANGELOG.md 不存在时提示未找到文件。
参考文件
工具依赖多个参考文件,包括语气指南、日志解析规则、内容转换映射、各格式模板以及示例输出。
限制
该工具生成的是草稿,建议在发布前审阅并个性化。--save 输出按 claudedocs/ 约定被 gitignore 忽略。关于收费、具体价格或更广泛的平台支持等信息,资料中暂未提供。