mcpField
G
guide-recap

guide-recap

github.com/florianbruniaux营销与增长6.3k45 次安装今天更新
代码仓库

关于 guide-recap

将 CHANGELOG.md 条目整理为发布公告或每周更新的社交媒体草稿。它筛选值得强调的变更,并生成 LinkedIn、Twitter/X、newsletter 和 Slack 内容,支持法语和英语。

主要功能

  1. 01读取版本或日期范围条目
  2. 02按相关性为变更排序
  3. 03生成四种帖子格式
  4. 04支持法语和英语
  5. 05交互选择角度与受众
  6. 06可将草稿保存到文件

适用场景

  1. 01为新版本准备社交媒体帖子
  2. 02汇总一周内的变更
  3. 03根据发布记录起草 newsletter
  4. 04为某个版本编写 Slack 更新

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/florianbruniaux/claude-code-ultimate-guide --skill guide-recap

安装后在 Claude Code 中输入/guide-recap确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

assets/
linkedin-template.md
newsletter-template.md
slack-template.md
twitter-template.md
examples/
version-output.md
week-output.md
references/
changelog-parsing-rules.md
content-transformation.md
tone-guidelines.md

详细介绍

指南回顾

根据 CHANGELOG.md 条目生成社交媒体内容。默认生成 8 份内容(4 种格式 × 2 种语言)。

适用场景

  • 运行 /release 后,创建社交媒体公告
  • 每周汇总多个版本
  • 发布到 LinkedIn、Twitter/X、新闻简报或 Slack 之前

用法

/guide-recap latest              # Latest released version
/guide-recap v3.20.5             # Specific version
/guide-recap week                # Current week (Monday to today)
/guide-recap week 2026-01-27     # Specific week (Monday to Sunday)
标志
标志效果默认值
--interactive引导模式:选择角度、受众和重点关闭(自动起草)
--format=X单一格式:linkedin、twitter、newsletter、slack全部 4 种格式
--lang=X单一语言:fr、en法语和英语
--save将输出保存到 claudedocs/social-posts/仅显示
--force即使只有维护类条目也生成跳过低分内容

工作流(7 个步骤)

第 1 步:解析输入

解析 $ARGUMENTS 以确定模式:

输入模式目标
latest单个版本[Unreleased] 后第一个 ## [X.Y.Z]
vX.Y.Z 或 X.Y.Z单个版本精确匹配的版本
week周范围本周星期一 -> 今天
week YYYY-MM-DD周范围指定日期所在周的星期一 -> 随后的星期日

如果没有参数或参数无效,显示用法并退出。

第 2 步:提取 CHANGELOG 条目

从项目根目录读取 CHANGELOG.md。

单个版本:

  1. 查找与 ## [{version}] 匹配的行
  2. 提取其后直到下一行 ## [ 之前的所有内容
  3. 解析 ### Added、### Changed、### Fixed 部分

周范围:

  1. 收集日期落在范围内的所有 ## [X.Y.Z] - YYYY-MM-DD 条目
  2. 解析所有匹配版本中的各个部分

错误:找不到版本 -> 列出最近 5 个版本,并建议使用 latest。 错误:该周没有条目 -> 显示上次发布的日期,并建议使用该版本。

第 3 步:分类条目

为每个顶层条目(### 下的第一级项目符号)分配一个类别:

类别权重判定依据
NEW_CONTENT3新文件、新章节、新图表、新测验题目
GROWTH_METRIC2行数增长、项目数量变化
RESEARCH1资源评估、外部来源集成
FIX1### Fixed 下的修正
MAINTENANCE0README 更新、徽章同步、着陆页同步、数量更新

详细分类规则请参阅 references/changelog-parsing-rules.md。

第 4 步:转化为用户价值

根据 references/content-transformation.md 中的映射进行转换:

  • 将技术语言转化为用户收益
  • 提取具体数字
  • 标明具名来源
  • 将相关条目归为一组

根据 references/tone-guidelines.md 中的“应做/不应做”清单进行验证。

第 4b 步:交互模式(仅限 --interactive)

如果设置了 --interactive 标志,则在第 4 步和第 5 步之间插入以下步骤:

  1. 显示候选重点及其分数:

    Highlights (by score):
    [14] 4 new ASCII diagrams (16 -> 20)     [NEW_CONTENT]
    [ 9] 30 new quiz questions (227 -> 257)   [NEW_CONTENT]
    [ 6] Docker sandbox isolation guide        [NEW_CONTENT]
    [ 1] README updated                        [MAINTENANCE]
    
  2. 询问切入角度:

    • 自动(得分最高的条目作为吸引点)
    • 用户选择具体条目作为吸引点
    • 自定义角度(用户提供主题)
  3. 询问目标受众:

    • devs(技术深度)
    • tech-leads(聚焦影响)
    • general(通俗易懂)
    • all(默认,兼顾各方)
  4. 询问主要重点:

    • 自动(得分最高)
    • 用户从列表中选择
  5. 确认选择并继续第 5 步。

第 5 步:评分和选择

计算每个条目的分数:

score = (category_weight * 3)
      + (has_number * 2)
      + (named_source * 1)
      + (new_file * 1)
      + (min(impact_files, 3))
      + (breaking * 2)

按分数选出排名前 3–4 的条目。得分最高的条目作为吸引点。

如果所有分数都 < 3:输出“此版本不建议生成社交媒体内容。使用 --force 可强制生成。”并退出(除非设置了 --force)。

步骤 6:生成内容

对于每种请求的格式(默认:全部 4 种)和语言(默认:两种):

  1. 从 assets/ 读取对应模板
  2. 使用评分和转换后的条目填写模板字段
  3. 按照 tone-guidelines.md 质量检查清单进行检查

链接:

格式链接目标
LinkedIn落地页 URL
TwitterGitHub 仓库 URL
Newsletter两者(落地页 + GitHub)
SlackGitHub 仓库 URL

URL:

  • 落地页:https://florianbruniaux.github.io/Codex-ultimate-guide-landing/
  • GitHub:https://github.com/FlorianBruniaux/Codex-ultimate-guide
步骤 7:输出

将生成的每篇帖子显示在围栏代码块中,并标注格式和语言:

## LinkedIn (FR)

```text
[content]
`` `

## LinkedIn (EN)

```text
[content]
`` `

## Twitter/X (FR)

```text
[content]
`` `

...

如果带有 --save 标志:将所有输出写入 claudedocs/social-posts/YYYY-MM-DD-vX.Y.Z.md(版本)或 claudedocs/social-posts/YYYY-MM-DD-week.md(周)。如果 claudedocs/social-posts/ 目录不存在,则创建该目录。

错误处理

错误响应
没有参数显示用法代码块
参数无效显示包含示例的用法代码块
未找到版本列出最近的 5 个版本,并建议使用 latest
本周没有条目显示上次发布的日期,并建议使用版本
所有条目均为 MAINTENANCE(评分为 0)“不建议生成社交内容。使用 --force 可强制生成。”
未找到 CHANGELOG.md“项目根目录中未找到 CHANGELOG.md。”

参考文件

  • references/tone-guidelines.md - DO/DON'T 规则、表情符号配额、语言风格
  • references/changelog-parsing-rules.md - CHANGELOG 格式、提取方式、评分算法
  • references/content-transformation.md - 技术内容到用户价值的映射(30+)
  • assets/linkedin-template.md - 约 1300 个字符,开场语 + 项目符号列表 + CTA + 标签
  • assets/twitter-template.md - 280 个字符的单条推文或 2–3 条推文串
  • assets/newsletter-template.md - 约 500 个单词,包含分节结构
  • assets/slack-template.md - 简洁、表情符号丰富,采用 Slack 格式
  • examples/version-output.md - v3.20.5 的完整输出示例
  • examples/week-output.md - 2026-01-27 当周的完整输出示例

提示

  • 发布 /release 后,立即运行 /guide-recap latest,以准备社交帖子
  • 前几次使用 --interactive,以了解评分方式
  • 只需要一种特定输出时,使用 --format=linkedin --lang=fr
  • 按照 claudedocs/ 约定,--save 的输出会被 git 忽略
  • 发布前请审核并个性化内容(这些只是草稿,并非最终文案)

评论

支持 Markdown