SuperAPI AI 工具集

sanity-changelog

写作与研究

查看项目

更新于 11-06 03:07

技能介绍

用途

sanity-changelog 是 Novu 团队维护更新日志的写作工作流,用于在 Sanity 的 changelogPost 文档类型中创建和发布更新日志条目。内容托管在 Sanity 项目 w2rl2099(“Novu Website”)、production 数据集、default 工作区。

主要能力

  • 支持两类条目:功能发布帖,以及“改进与修复”汇总(从 Linear 发布记录整理)。
  • 通过 Sanity MCP(plugin-sanity-Sanity)操作文档,通过 Linear MCP(plugin-linear-linear)查阅发布记录。
  • 在运行时用 GROQ 解析作者、分类、标签等引用文档的 _id,避免硬编码。
  • 使用 changeBlock 对象组织“改进与修复”区块,类型为 improvements 或 fixes,条目为 portable text 并可选引用标签。
  • 支持对已有草稿做定向修补,保留用户已上传的图片、作者、说明和 publishedAt。

使用方式

工作流步骤:

  1. 加载 reference.md,确认项目与数据集。reference.md 中包含连接常量、全部模板与 ID。
  2. 通过 GROQ 解析作者与分类(及标签)的引用 ID。作者取发布/宣布该功能的人,并选择 1–2 个分类(如 Dashboard + New Feature,或 Improvement + Bug Fix)。
  3. 收集素材:功能帖需了解功能真实行为,可查看相关 apps/ 或 packages/ 代码(或交给 explore 子代理),不夸大设计稿;汇总帖需查看上次已发布更新日志之后的 Linear 发布。
  4. 按 Novu 更新日志语气起草:面向收益、具体、主动语态、短段落。功能帖结构为引言段 → h2 小节 → 可选 codeBlock → 结尾附文档链接;汇总条目为加粗引导标签 + 破折号 + 一句清晰说明,按领域分组,公开文案不出现 NV-xxxx 编号。
  5. 用 Sanity MCP 的 create_documents 以草稿形式创建,采用 reference.md 中的 Portable Text 结构,每个 block/span 需唯一 _key,保持 JSON 合法。
  6. 处理图片:Sanity MCP 无法上传本地图片(generate_image 只生成 AI 图片),需用户在 Studio 的 Cover Image 字段或内嵌图片块中手动放入,或在提供 Sanity 写入令牌时通过资源 HTTP API 上传并设置 asset._ref。
  7. 报告草稿 ID 与 Studio 链接;仅在明确要求时发布。

编辑已有草稿时,使用 patch_documents 的 insert(before / after / replace)按 _key 定位数组项(如 content[_key=="fd1ce739c172"])。删除冗余草稿用 discard_drafts(对从未发布的草稿为永久删除,需确认意图)。发布用 publish_documents,且仅在明确请求时执行。

适用场景

适合 Novu 团队发布新功能说明、整理阶段性改进与修复汇总,并保持更新日志语气与结构一致。

限制

  • 始终以草稿创建(不设置 publishedAt),除非明确要求否则不发布。
  • 无法通过 MCP 上传本地图片,需手动上传或提供写入令牌走 HTTP API。
  • 汇总内容需过滤掉依赖/CVE 升级、内部重构、测试/CI 和未完成脚手架,仅保留客户相关内容。
  • 参考资料中提及的模板、连接常量等需先读取 reference.md。