写在前面
在技术文档写作过程中,通常需要技术文档工程师收集并整理汇总产品当前版本中包括什么功能,即,发版说明(又称,ReleaseNotes),那么应该怎么编写呢?下文根据个人经验,总结以下内容,供大家参考。
内容要点
内容主要包含本次发版的产品的某一功能或特性
- 发生了什么变化?
- 为什么变了?
- 用户如何受到影响?
- 用户现在需要做什么?
编写规则
- 专注于对客户的价值
- 使用简单的语言
编写方法
编写方法一般情况下有如下两种方式:
● 从feature的角度写。通常当该feature (如新改进New UI或 New settings等)很难通过三言两语说清对核心读者的Benefit就只写提供什么new changes,或者,该feature达到的目的不是用户take action就能实现的,才选择此种方法。突出新Item的特性或是陈述新feature
● 从用户操作的角度写。以核心读者(你)为核心,该新的feature可以让你直接完成哪些“以前”不能做的事,你可以直接通过很直接的界面操作,达到目的。
[功能点] + [功能描述/功能价值点/benefit]
编写样例
写在后面
发版说明的编写需要根据不同产品发布的特点及受众群体的特点,决定是偏清晰描述还是偏概括抽象。