第2章 如何撰写产品文档

2.1 撰写产品文档的基本方法

文档撰写能力是产品经理必须具备的最基本的能力之一。在实际的产品工作中，产品经理要输出各种类型的文档，例如，商业需求文档、市场需求文档、产品需求文档，以及竞品分析文档等。写作本质上是把自己的思考进行文本化表达的过程，最终目的是让阅读对象清晰地阅读并理解文档的内容。撰写产品文档并不需要产品经理拥有很强的文字驾驭能力（当然，有这种能力更好），只要掌握基本的文档撰写方法和规范，就能写出合格的产品文档。

图2-1是产品经理在撰写产品文档的过程中可以使用的一套完整的产品文档撰

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

写方法。这个方法有3个步骤，分别是定范围、选模板、规范化。本节将详细介绍如何利用这3个步骤撰写一篇产品文档。

1．定范围

当产品经理要撰写一个产品文档时，首先要定好产品文档的范围，通常要明确以下5点。

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

● 文档目的（用清晰简洁的语言描述文档的用途）。

● 文档归属/阅读对象（通常文档归属于文档的撰写人或其所在的组织，文档的撰写人或其所在组织对文档内容拥有解释权。阅读对象则是适合或有权阅读此文档的人或组织）。

● 创建时间/更新时间（创建时间和更新时间在文档刚创建时是一致的，后续每次更新，创建时间不变，更新时间随文档的更新而改变）。

● 其他范围（补充文档范围内的其他要素，如一些文档有关于保密等级的说明等）。

2．选模板

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

而产品工作中的很多文档类型（例如，产品经理经常需要写的三大文档，以及产品体验报告、用户调研报告、行业分析报告等）有比较固定的模板。产品经理在撰写文档时，只需要按照固定的模板填充需要的内容，就可以快速、高效地输出专业的文档。

3．规范化

规范化是产品经理在职业成长过程中需要具备的一项基本职业素质。规范包含的内容很多，小到文档撰写、原型设计的规范，大到用户调研、需求分析及产品设计的规范。做事规范化是产品经理专业化的基本要求之一。文档撰写通常需要遵守以下3个规范。

● 命名规范。产品文档标题的命名不仅要考虑标题是否可以准确表达文档的定位和类型，还要考虑标题名称是否会引起歧义。通用的命名规则为描述对象+版本号，例如，CRM系统产品需求文档V1.0.0，标题中加版本号的目的是记录整个文档在输出过程中的迭代过程。当然，如果输出的文档是最终版，且以后不会再次修订，则无须添加版本号。

● 表达规范。在文档撰写过程中，注意文本表达要规范，尽量避免使用口语化的表达，如“我认为” “我觉得”“接下来我们”“那咱们”等表达句式。这种口语化的表达会降低文档的专业性和严谨性，也会给阅读对象留下不专业的印象。

● 版本号规范。一个文档经常会被修订多次才输出最终版，因此每次编辑结束的时候都需要进行版本的更新，以保证其他编辑人员了解上个版本编辑过的内容，同时让阅读人员能了解文档的更新历史。版本更新的内容包括版本号、修订人（当前版本的修订人）、修订时间（当前版本的修订时间）、修订内容（当前版本新增或删除了哪些内容）、备注（对当前版本的一些附加说明）等。

其中，版本号用来识别当前版本，标准的版本号采用“VX.Y.Z”的格式。例如，V1.1.0中，V表示版本号，即Version Number；X、Y、Z 为非负的整数，X是主版本号，Y是次版本号，Z为修订号。首次发布的版本命名为V1.0.0，后期每更新一个版本，就在主版本号上加1。

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

● 当对文档进行小规模的修订时，修改、叠加第3位数字，即Z+1，其他不变。例如，V1.0.0变为V1.0.1。

● 当对文档进行中等规模的修订时，修改、叠加第2位数字，即Y+1，其他不变。例如，V1.0.0变为V1.1.0。

● 当对文档进行大规模的改动时，修改、叠加第1位数字，即X+1，其他不变。例如，V1.0.0变为V2.0.0。

● 位于前面的数字叠加后，后面的数字从零开始计算。例如，V1.0.1变为V1.1.0，V1.2.1变为V2.0.0。

最后，除按照以上几点要求规范自己的文档输出之外，读者还可以在平时的产品工作中不断地实践和积累，总结出一套属于自己的规范，为产品工作的专业化和职业化打好基础。