Files
goodbuddy/docs/pr-articles/featured-template.md
T

1.5 KiB

重点 PR 模板

适用于新增一项值得专门介绍的能力,或明显改变某种工作方式的更新,例如外部知识库接入。 围绕一个主题,用真实任务和结果说明能力。没有必要不铺背景,不编造用户经历或设计动机。

写作前在本轮 review.md 记录目标读者、实际任务、本轮变化、主要证据、使用条件和文章取舍。 方括号是编辑提示,发布前删除或替换。各节按内容增删,不规定字数和功能数量。

# [具体功能或用途,版本号可放副标题]

[直接介绍本次新增的能力、适用的人和使用条件。]

## [一个实际任务]

[使用公开或明确标识的演示资料,说明准备完成什么任务。]

![说明图片内容的替代文本](assets/实际图片文件名.png)

[图注说明实际操作或结果。]

[结合操作结果介绍功能。截图能看懂的内容不重复说明,正文补充必要解释。]

## [值得单独解释的能力或设计选择,可省略]

[根据功能展开。设计原因须有依据,不虚构用户反馈或研发故事。]

[影响使用的前提、费用、数据流向或限制,按实际需要说明。]

[可用版本、体验入口、使用文档。]
[必要的升级说明。]

审校时检查:标题是否超出实际能力;演示是否支撑主要结论;是否混入无关的小更新; 是否重复描述同一价值。配图按截图步骤取得,完整流程见工作流。