产品文档撰写的基本方法

图2-1是产品经理撰写文档过程中可利用的一套完全的文档撰写方法，这个方法有三个步骤：定例模、选模板，守规范。

图2-1产品文档撰写的基本方法

（1）定例模

当我们撰写一个完全的产品文档时，首先要定好文档的范围，常日要明确以下几点：

① 文档标题 （哀求定位清晰，内容明确，如果文档还在修订过程中，须要在标题后面加上版本号）。

② 文档目的（用清晰简洁的措辞描述文档的用场）。

③ 文档归属/阅读工具（常日归属于文档的撰写人或其所在的组织，并对文档拥有阐明权。
阅读工具则声明适宜或有权阅读此文档的人或组织）;

④ 创建韶光/更新韶光（创建韶光和更新韶光在文档创建时是同等的，后续每次更新，创建韶光不变，更新韶光随文档更新而更新）;

⑤ 其它范围（作为文档范围的其它要素补充，例如一些文档有关于保密等级的解释等）。

（2）选模板

确定文档范围后，接下来进入文档正文的撰写阶段，根据文档类型选择一个得当的模板，模板供应了一种通用的格式框架，好处是文档输出者可以直接套用，无需重新设计框架，提高文档输出效率的同时，也一定程度上使得不同期间，不同人输出的文档具备统一性和规范性。

而产品事情中的很多文档类型都有通用的模板，例如产品经理常常须要写的三大文档（BRD、MRD，PRD），以及产品体验报告、用户调研报告、行业剖析报告等都有比较固定的模板格式， 在文档撰写的时候只须要按照固定的模板格式，添补须要的内容就可以快速高效的输出专业的文档。

（3）守规范

规范化是产品经理在职业发展过程中须要具备的一项基本职业本色，小到文档撰写和原型设计的规范，大到用户调研、需求剖析、以及产品设计的规范，干事规范化是产品经理专业化的基本哀求之一，文档撰写常日须要遵守以下几种规范。

① 命名规范

标题命名时不仅要考虑标题可以准确传达文档的定位和类型，还要考虑标题名称是否会引起歧义。
通用的命名规则为：描述工具+版本号。
例如：CRM系统产品需求文档v1.0.0，一样平常文档常日都用这个格式来命名，版本号的目的是为了记录全体文档输出过程中的迭代过程。
当然，一些文档如果已经正式输出的是终极版，且往后也不会再次修订，则无需添加版本号。

② 表达规范

在文档撰写过程中，要把稳一些文本表达的规范，只管即便避免利用口语化的表达，例如：“我认为”；“我以为”；“接下来我们”“那咱们”；等这样的表达句式，这种口语化的句式会影响文档的专业性和严谨性，也会给阅读工具留下不专业的印象。

③ 版本号规范

一个文档常常会被修订多次终极输出终版，每次编辑结束的时候都须要进行版本的更新，以担保其他编辑者理解上个版本编辑的内容，同时让阅读者也能清晰文档的更新历史。
版本更新的内容包括版本号、修订人（当然版本的修订人）、修订韶光（当前版本的修订韶光）、修订内容（当前版本修正，新增或删除了那些内容）、备注（对当前版本的一些附加解释）等。

个中版本号是用来识别当前版本唯一性的命名办法，标准的版本号采取 VX.Y.Z 的格式。
例如V1.1.0个中 V表示版本号 ：Version Number ，简写为 V。
X、Y、Z 为非负的整数。
X 是主版本号、Y 是次版本号、 Z 为修订号。
首次发布的版本命名为v1.0.0。
后期每更新一个版本，就在版本号上+1。

以下是文档版本更新的一些通用规则：

1. 当对文档进行小规模的修订时，修正叠加第三位数字，即Z+1，其他不变。
例如：v1.0.0——V1.0.1。

2.当对文档进行中等规模的修订，修正叠加第二位数次，即Y+1，其他不变。
例如：v1.0.0——V1.1.0。

3.当对文档进行大规模的改动时，修正叠加第一位数次，即X+1，其他不变。
例如：v1.0.0——V2.0.0。

4.前面的位数叠加后，后面的位数从零开始打算。
例如v1.0.1——V1.1.0，v1.2.1——V2.0.0。

末了，希望读者们除了按照以上的几点哀求，规范自己的文档输出之外，能在平时产品事情中不断的实践和积累，总结出一套属于自己的规范，为往后的专业化和职业化打好根本。