SuperAPI AI 工具集

changelog-writer

写作与研究

查看项目

更新于 10-16 00:00

技能介绍

changelog-writer 用于撰写 Lightfast 版本的用户向更新日志(release notes、版本更新、产品 changelog),核心原则是事实核查优先:写之前先对照 docs/architecture/implementation-status/README.md 核对哪些已完成、哪些仍是计划、当前限制和已知缺口,不确定就要求澄清,禁止夸大。

主要写法要求:每个功能 1-3 句、简洁可扫读;先讲用户能做什么再讲怎么做;如实标注 beta 状态、上线时间与限制;使用主动语态(“You can now...”);不用 emoji;给出具体名称(如 “GitHub File Sync (File Contents)” 而非宽泛的 “GitHub Integration”),并披露限制(如“目前支持 X;Y 将在 vZ 提供”,条件性功能写“当 3+ 客户请求时”);引用数字或功能前须在实现文档中确认。

SEO/AEO 方面:自然使用目标关键词,为 AI 引用引擎写 tldr,为列表页写 excerpt,FAQ 问题要匹配真实搜索词且答案完整,并链接 3-5 篇相关文档。

工作流:收集 PR 编号/URL 或手工变更清单 → 读实现状态核查 → 按模板起草 → 交叉核对 → 按 seo-requirements 补 SEO 元素 → 用清单复核。草稿保存到 thoughts/changelog/{title-slug}-{YYYYMMDD-HHMMSS}.md。必备 frontmatter 含 title、slug、publishedAt、excerpt、tldr、seo.metaDescription、seo.focusKeyword、_internal.status、_internal.source_prs;prefix 与 slug 是两个独立字段,prefix 为版本标识(格式 \d+-\d+,BaseHub 正则 ^\d+-\d+$),slug 为不含版本前缀的描述性 URL 段(如 lightfast-neural-memory-foundation-2026)。推荐补充 seo.secondaryKeyword 与 seo.faq[]。frontmatter 结构对应 ChangelogEntryInput 类型,可用 /publish_changelog 发布到 BaseHub。模板与清单见 resources/templates.md 等资源。资料未提供安装方式、平台限制与收费信息。