为什么需要人工润色？
自动生成的发布说明虽然高效，但存在两个关键不足：
- 缺乏重点突出：无法自动识别哪些变更对用户影响最大
- 缺少操作指导：用户不知道如何安全升级
这正是人工润色的价值所在——将技术变更转化为用户可执行的指导。
润色核心要素
1. 重要说明 (Highlights)
目的：帮助用户快速抓住版本核心价值 内容要素：
- 突破性改进
- 关键安全更新
- 重大性能优化
- 影响范围大的变更
编写技巧：
## 🚀 重要说明
> 本版本包含**突破性变更**，建议所有用户升级！
>
> ### 核心亮点
> - **性能飞跃**：虚拟 DOM 算法优化，渲染速度提升 40%
> - **安全加固**：修复 XSS 漏洞 (CVE-2023-XXXXX)
> - **全新特性**：支持 Composition API（需单独安装插件）
>
> ⚠️ **特别注意**：移除了对 IE11 的支持，如需兼容请使用 v2.6.x
2. 迁移指南 (Migration Guide)
目的：提供从旧版本升级的明确路径 内容要素：
- 破坏性变更列表
- 分步迁移步骤
- 代码修改示例
- 常见问题解决方案
编写技巧：
## 🧭 迁移指南
### 从 v2.6 升级到 v2.7
#### 1. API 变更处理
**变更**：`Vue.filter` 已被移除
```javascript
// 旧代码 (v2.6)
Vue.filter('currency', value => `$${value}`)
// 新方案 (v2.7)
// 方案A：全局方法
Vue.prototype.$currency = value => `$${value}`
// 方案B：组件内方法
methods: {
currency(value) {
return `$${value}`
}
}
专业润色工作流
最佳实践流程
graph TD
A[自动生成基础发布说明] --> B[技术作者审阅变更]
B --> C{变更分类}
C -->|破坏性变更| D[编写迁移指南]
C -->|安全更新| E[突出安全说明]
C -->|性能优化| F[量化性能提升]
D --> G[添加代码示例]
E --> H[添加CVE编号]
F --> I[添加基准测试数据]
G --> J[组合成最终文档]
H --> J
I --> J
内容定位策略
| 内容类型 | 位置 | 目标读者 | 语言风格 |
|---|---|---|---|
| 重要说明 | 文档最顶部 | 所有用户 | 简洁、警示性强 |
| 迁移指南 | 重要说明下方 | 升级决策者 | 详细、步骤明确 |
| 自动生成日志 | 文档底部 | 技术细节关注者 | 技术术语为主 |
润色专家技巧
-
风险可视化：使用表情符号和颜色代码
- 移除 filter 管道功能 + ❗移除 filter 管道功能（破坏性变更） -
版本对比表：清晰展示变化
功能 v2.6 v2.7 TypeScript 基本支持 完整类型定义 IE11 官方支持 不再支持 包大小 92KB 87KB (-5%) -
决策流程图：帮助用户选择
graph LR A[需要IE11支持?] -- Yes --> B[使用 v2.6.x] A -- No --> C[需要Composition API?] -- Yes --> D[使用 v2.7 + 插件] C -- No --> E[直接使用 v2.7] -
常见错误速查：
## 🆘 常见问题 **Q：升级后模板编译失败** A：确保已更新 vue-template-compiler： ```bash npm install vue-template-compiler@2.7.0 -DQ：TypeScript 类型报错
A：删除旧的 @vue/types 包，使用内置类型
总结：优秀发布说明的金字塔结构
/ \
/ \
/ \
/ 致谢 \
/_______ __\
/迁移指南示例 \
/_____________ \
/ 迁移步骤 \
/_______________ \
/ 重要说明 \
/________________ _\
/ 自动生成变更日志 \
/___________________ __\
遵循以下原则：
- 用户视角优先：考虑用户最关心什么
- 风险前置：重要变更放在最前面
- 可操作性：提供明确的升级路径
- 版本化存档：每个版本独立文档
- 自动化+人工：结合二者优势
