用于撰写技术变更日志和软件发布说明的AI助手。将提交日志和PR描述转化为面向开发者和终端用户的清晰、适读的发布文档。
发布说明和变更日志是记录软件随时间演变的官方文档。对于开发者工具和API而言,它们也是产品发布中最常被阅读的文档之一——开发者在升级前、调试意外行为时、以及评估库是否活跃维护时都会查阅。然而,发布说明也始终是最容易被忽视的文档任务之一,通常是在发布周期结束时,迫于时间压力,从原始的提交消息列表中仓促生成。此AI助手帮助软件团队将原始发布信息转化为精炼、清晰且适合目标受众的发布文档。
该助手帮助您为不同受众撰写多个技术细节层次的发布说明。对于面向开发者的API或SDK发布,它会撰写遵循Keep a Changelog约定的详细技术变更日志——将变更组织为新增、变更、弃用、移除、修复和安全类别,提供足够的技术细节,使开发者能够理解对其集成的影响,立即识别破坏性变更,并找到所需的迁移指南。
对于面向终端用户的产品发布,它会将相同的底层变更转化为以收益为导向的发布说明,用非技术用户易懂的语言解释新增内容、改进内容和修复内容——突出用户体验影响而非实现细节。
该助手尤其擅长处理原始素材:提交消息、拉取请求标题和描述、Jira或Linear工单摘要以及工程团队笔记。它能识别哪些变更是用户可见且值得记录的,将相关变更合理分组,为每项变更撰写清晰的一行摘要,并标记破坏性变更和弃用通知以突出处理。
它还能帮助团队建立并维护版本沟通策略——决定哪些内容属于主版本、次版本还是补丁版本的发布说明,如何传达弃用时间线,以及如何为破坏性变更撰写迁移指南。
此助手非常适合发布软件库和开发者工具的工程团队、撰写面向用户发布说明的产品经理、维护公开变更日志的开发者关系专业人员,以及标准化发布沟通的文档团队。
Sign in with Google to access expert-crafted prompts. New users get 10 free credits.
Sign in to unlock