用途
product-update-logger 用于把产品发布内容整理成规范的更新日志,并同步生成一组可直接发布的内容素材。用户只需告诉它产品发布了什么,它就会写入 docs/changelog.md(持续更新的日志,最新条目置顶),并同时产出内容包:推文串、LinkedIn 帖子、邮件片段和一句话简介。
主要能力
- 写入更新日志:将条目按 New、Improved、Fixed、Under the hood 分类,以过去时(Added、Fixed、Improved)撰写,并生成版本标签。
- 生成内容包:一句话简介(最多 20 词)、推文串(3-5 条,每条严格少于 280 字符)、LinkedIn 帖子(150-400 词,纯文本)、邮件片段(主题 + 50-100 词正文)。
- 多来源输入:支持自由文本、自动读取本地 git 提交、以及在提供仓库时读取 GitHub PR,任意组合均可。
- 噪音过滤:过滤测试变更、CI 变更、纯文档提交等不面向用户的内容。
- 自检:检查禁用词、破折号、推文长度、LinkedIn 话题标签与 markdown 格式、一句话简介词数等。
使用方式
技能按步骤执行:先做环境检查(GITHUB_TOKEN、git 仓库、changelog 是否存在),再解析输入(items、since、repo、version_label),随后运行 scripts/gather.py 收集条目并让用户确认,然后生成 changelog 条目与内容包,进行自检,最后追加到 docs/changelog.md 并把内容包保存到 docs/product-updates/[date]-content.md。
输入参数包括:items(自由文本,多个用竖线分隔)、since(回溯天数,默认 7)、repo(GitHub "owner/repo",可选)、version_label(自定义标签,可选,默认基于日期)。
适用场景
适合需要定期发布产品更新、并希望同步产出社交媒体与邮件内容的团队或个人,尤其是使用 git 或 GitHub 管理代码、希望从提交或 PR 自动提取发布内容的场景。
限制
- 不得编造结果或指标:如“40% faster”必须来自源数据,提交或 PR 中没有数字就不能添加。
- 不使用话题标签,不使用 em dash,不使用“We are excited to announce”等禁用词。
- LinkedIn 帖子不使用 markdown(星号会显示为字面字符)。
- 若 total_items 为 0 则停止,并提示用户描述发布内容、指向有近期提交的 git 仓库,或提供 repo 与 GITHUB_TOKEN。
- 需要用户确认条目列表后再进行转换。
- 具体收费、价格、平台支持范围等信息暂未提供。