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

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

作者: UU5Xin | 来源:发表于2022-05-08 12:07 被阅读0次

写在前面

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

内容要点

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

  • 发生了什么变化?
  • 为什么变了?
  • 用户如何受到影响?
  • 用户现在需要做什么?

编写规则

  • 专注于对客户的价值
  • 使用简单的语言

编写方法

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

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

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

[功能点] + [功能描述/功能价值点/benefit]

编写样例

编写样例大纲 编写样例

写在后面

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

相关文章

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

    写在前面 在技术文档写作过程中,通常需要技术文档工程师收集并整理汇总产品当前版本中包括什么功能,即,发版说明(又称...

  • 技术文档如何编写?

    关于文档编写的几个思维 近期重新组织了好几篇技术文档,把其中的一些感悟提炼出来。 文档为达到容易理解和操作的程度,...

  • 2018-09-12星期三

    《业务需求说明》的第一版整合60%开始《需求规格说明书》的编写功能角色矩阵编写完成APP接口文档编写出大纲原型的一...

  • 编写文档说明

    一级标题 二级标题 三级标题 *斜体 ***粗体 ** 列表: 第一(注意空格) 第二 无序列表: x y 146...

  • 使用swagger管理rest api

    背景 项目有部分rest api提供给第三方使用,这部分API的说明由技术文档人员编写。由于技术文档人员对API的...

  • 如何基于 Markdown 编写技术文档

    需求 文档版本清晰化,充分利用Git 的版本管理能力,轻松对比不同版的修改演进。 减少在文档格式排版上的投入,争取...

  • iOS集成腾讯云移动直播SDK

    说明:本次集成的SDK为基础版。因为官方文档有些地方比较坑,以此记录来帮助可能会踩坑的人。本文借鉴官方文档编写,加...

  • PHP_DOC 实时生成 API 文档

    随着API的迅速发展,如何编写出更加规范的API文档说明则显的尤为重要。你是否还通过手写的方式来生成和编写这些文档...

  • 如何编写产品说明文档?

    1、熟悉项目发生的相关业务行为。 言下之意,就是说:我们要做的是什么项目,我们这个项目主要是做什么业务,具体业务我...

  • Markdown测试

    『Cmd 技术渲染的沙箱页面,点击此处编写自己的文档』『Cmd 技术渲染的沙箱页面,点击此处编写自己的的文档』 C...

网友评论

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

      本文链接:https://www.haomeiwen.com/subject/elqqurtx.html