技术文档 | 如何编写对外的发版说明

在技术文档写作过程中，通常需要技术文档工程师收集并整理汇总产品当前版本中包括什么功能，即，发版说明（又称，ReleaseNotes）,那么应该怎么编写呢？下文根据个人经验，总结以下内容，供大家参考。

内容主要包含本次发版的产品的某一功能或特性

编写方法一般情况下有如下两种方式：

● 从feature的角度写。通常当该feature (如新改进New UI或 New settings等）很难通过三言两语说清对核心读者的Benefit就只写提供什么new changes，或者，该feature达到的目的不是用户take action就能实现的，才选择此种方法。突出新Item的特性或是陈述新feature

● 从用户 *** 作的角度写。以核心读者（你）为核心，该新的feature可以让你直接完成哪些“以前”不能做的事，你可以直接通过很直接的界面 *** 作，达到目的。

发版说明的编写需要根据不同产品发布的特点及受众群体的特点，决定是偏清晰描述还是偏概括抽象。

《GB/T 19001-2016 信息技术 技术文件的编写规则》是国家标准对技术文件的定义。技术文件是指用于记录、描述、说明技术要求、技术数据、技术过程、技术控制、技术指导和技术信息等内容的文件。它可以是技术规范、技术规程、技术标准、技术报告、技术 *** 作规程、技术方案、技术文献等。技术文件的编写应遵循有关规定，其中包括文件的类型、文件的编写规则和文件的组织结构。

一般要求：

1、在技术负责人的主持下，建设单位和项目部应建立适合本项目正常执行和实施的施工技术交底制度。

2、明确项目负责人、技术员、施工人员、管理人员和 *** 作人员的职责。在项目开始前确定项目的技术基础是很重要的。对于重要的技术基础，项目技术经理应在项目完成后由项目技术人员审核或批准，技术主管应在项目完成时就位。

整个施工过程，包括工程各个部分的施工，都要有技术基础。对于一些特殊的重点部位和困难的技术隐蔽工程，应认真做好技术基础。

在重点分析易发生质量事故和工伤事故的工作类型和工程部件时，应加强事故预防。

3、技术交底应在不同层次进行，直至施工人员对底线进行交底。作业前必须进行底部作业，并有书面材料。

4、在技术交底前，应编写技术交底资料、论证和论证准备。

5、技术交底记录是履行职责的依据，应当及时完成。技术记录表应当有统一的标准格式。职员应仔细填写表格并在表格上签名。验收人还应在记录上签字。

6、技术交底的数据和记录应当收集、整理，并妥善保存。完成后，它被归档为一个项目文件。

7、总的来说，在工程建设中只做一次技术基础是不合适的。当技术人员认为很难保证施工的正常进度时，应及时给予底部。

根据具体问题类型，进行步骤拆解／原因原理分析／内容拓展等。

具体步骤如下：／导致这种情况的原因主要是……

---