关于 changelog-writing
changelog-writing 是在功能分支完成后撰写变更日志的技能。它收集改动和文档背景,生成面向用户的内容,并提出图片与链接建议。
主要功能
- 01检查分支改动及相关背景
- 02参考近期变更日志示例
- 03查找相关文档
- 04撰写面向用户的发布说明
- 05建议图片和文档链接
适用场景
- 01为已完成的功能撰写变更日志
- 02确定发布内容的文档链接
- 03判断是否需要添加截图
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ langfuse/ langfuse --skill changelog-writing安装后在 Claude Code 中输入/changelog-writing确认已加载。
详细介绍
更新日志撰写
当已完成的功能分支需要一条更新日志条目时,使用此技能。
工作流
- 理解变更集。
- 研究
../langfuse-docs/pages/changelog中近期更新日志的模式。 - 在
../langfuse-docs/pages中查找相关文档链接。 - 起草一条面向用户的更新日志条目。
- 建议是否应添加图片或截图。
需要收集的内容
- 该分支相对于
main的 diff - 如果分支名称包含
lfe-XXXX标识符,则收集对应的 Linear 议题 - 受影响的产品领域
- 需要链接或创建的相关文档页面
撰写规则
- 面向用户撰写,而非内部实现细节
- 条目中绝不提及内部工单 id 或 Linear URL,即使第 2 步会收集 Linear 议题以提供上下文
- 优先使用第二人称:“你现在可以……”
- 聚焦于变更了什么、为何重要以及如何使用
- 与近期更新日志文章的结构和语气保持一致
- 仅在有助于用户理解时保留技术细节
输出格式
提供:
- 变更内容的简短摘要
- 完整的更新日志文章内容
- 是否应添加图片以及图片应展示什么
- 应链接或创建的任何文档页面
参考文件
- 更新日志目标位置:
../langfuse-docs/pages/changelog - 近期更新日志示例:查看该目录中 3-5 个近期文件
- 现有文档:
../langfuse-docs/pages
评论
支持 Markdown