10.2 发布说明写法
发布说明是每次文档或产品更新时向用户传达变更内容的重要文档。
R-163
必须
发布说明必须包含版本号和日期
每份发布说明必须在显著位置标注版本号和发布日期。版本号应使用语义化格式，日期应使用 ISO 8601 格式（YYYY-MM-DD）。如果发布说明涉及多个版本，应按版本号降序排列，最新版本在最前面。
R-164
推荐
变更内容应按类型分类
发布说明中的变更内容应按类型进行分类展示，使用户能够快速找到关心的变更。常见的变更类型包括新增功能、功能优化、问题修复、已知问题、废弃功能和安全更新等。每个变更条目应简洁明了地描述变更内容和对用户的影响。
变更类型分类
| 类型 | 英文标签 | 说明 | 示例 |
|---|---|---|---|
| 新增功能 | New Features | 本版本中新添加的功能或能力 | 新增 DITA 2.0 格式导入支持 |
| 功能优化 | Improvements | 对现有功能的增强和改进 | 搜索响应时间缩短 60% |
| 问题修复 | Bug Fixes | 已修复的缺陷和异常行为 | 修复中文标点导出显示异常 |
| 已知问题 | Known Issues | 当前版本存在但尚未修复的问题 | 大文件导入可能超时 |
| 废弃功能 | Deprecated | 计划在未来版本中移除的功能 | 旧版导出接口将在 v3.0 移除 |
| 安全更新 | Security | 安全漏洞修复和安全性增强 | 修复用户会话劫持漏洞 |
发布说明模板
# v2.1.0 发布说明
发布日期：2026-01-15
## 新增功能
- 支持 DITA 2.0 格式导入
- 新增批量导出 PDF 功能
## 功能优化
- 优化搜索性能，响应时间缩短 60%
- 改进术语表的筛选交互
## 问题修复
- 修复中文标点在导出时显示异常的问题
- 修复特定情况下图片无法加载的问题
## 已知问题
- 大文件（>100MB）导入可能超时，将在下一版本修复
提示
发布说明应面向用户视角撰写，使用用户能理解的语言描述变更内容和影响。避免使用内部术语、代码变量名或 JIRA 编号等用户无法理解的信息。例如，应写「修复了搜索结果排序不正确的问题」，而非「修复了 sortResults() 函数的 NPE 异常」。