江苏龙网

  1. 首页 > 人文 > >

优秀主义产品文档撰写的基本方法


文档能力是产品经理最基本的能力之一 ， 学生时代我们写的日记、作文、报告 ， 以及论文等 ， 都是在以不同的形式输出文档 。 实际的产品工作中输出产品文档的过程 ， 本质上是把自己的产品逻辑进行文本化的描述的过程 ， 最终目的是让阅读对象能清晰的阅读并理解 ， 产品相关文档撰写并不需要产品经理拥有很强的文字驾驭能力（当然有这种能力是更好） ， 只要掌握基本的文档撰写方法和规范就能写出合格的文档 。如图2-1所示 ， 展示了产品经理文档撰写的基本方法 。
图2-1是产品经理撰写文档过程中可使用的一套完整的文档撰写方法 ， 这个方法有三个步骤：定范围、选模板 ， 守规范 。 下文将详细介绍如何利用这三个步骤完成一篇产品文档的撰写 。
优秀主义产品文档撰写的基本方法
本文插图
图2-1产品文档撰写的基本方法
（1）定范围
当我们撰写一个完整的产品文档时 ， 首先要定好文档的范围 ， 通常要明确以下几点：
① 文档标题（要求定位清晰 ， 内容明确 ， 如果文档还在修订过程中 ， 需要在标题后面加上版本号） 。
② 文档目的（用清晰简洁的语言描述文档的用途） 。
③ 文档归属/阅读对象（通常归属于文档的撰写人或其所在的组织 ， 并对文档拥有解释权 。 阅读对象则声明适合或有权阅读此文档的人或组织）;
④ 创建时间/更新时间（创建时间和更新时间在文档创建时是一致的 ， 后续每次更新 ， 创建时间不变 ， 更新时间随文档更新而更新）;
⑤ 其它范围（作为文档范围的其它要素补充 ， 例如一些文档有关于保密等级的说明等） 。
（2）选模板
确定文档范围后 ， 接下来进入文档正文的撰写阶段 ， 根据文档类型选择一个合适的模板 ， 模板提供了一种通用的格式框架 ， 好处是文档输出者可以直接套用 ， 无需重新设计框架 ， 提高文档输出效率的同时 ， 也一定程度上使得不同时期 ， 不同人输出的文档具备统一性和规范性 。
【优秀主义产品文档撰写的基本方法】而产品工作中的很多文档类型都有通用的模板 ， 例如产品经理经常需要写的三大文档（BRD、MRD ， PRD） ， 以及产品体验报告、用户调研报告、行业分析报告等都有比较固定的模板格式 ，在文档撰写的时候只需要按照固定的模板格式 ， 填充需要的内容就可以快速高效的输出专业的文档 。
（3）守规范
规范化是产品经理在职业成长过程中需要具备的一项基本职业素质 ， 小到文档撰写和原型设计的规范 ， 大到用户调研、需求分析、以及产品设计的规范 ， 做事规范化是产品经理专业化的基本要求之一 ， 文档撰写通常需要遵守以下几种规范 。
① 命名规范
标题命名时不仅要考虑标题可以准确传达文档的定位和类型 ， 还要考虑标题名称是否会引起歧义 。 通用的命名规则为：描述对象+版本号 。 例如：CRM系统产品需求文档v1.0.0 ， 一般文档通常都用这个格式来命名 ， 版本号的目的是为了记录整个文档输出过程中的迭代过程 。 当然 ， 一些文档如果已经正式输出的是最终版 ， 且以后也不会再次修订 ， 则无需添加版本号 。
② 表达规范
在文档撰写过程中 ， 要注意一些文本表达的规范 ， 尽量避免使用口语化的表达 ， 例如：“我认为”；“我觉得”；“接下来我们”“那咱们”；等这样的表达句式 ， 这种口语化的句式会影响文档的专业性和严谨性 ， 也会给阅读对象留下不专业的印象 。
③ 版本号规范
一个文档经常会被修订多次最终输出终版 ， 每次编辑结束的时候都需要进行版本的更新 ， 以保证其他编辑者了解上个版本编辑的内容 ， 同时让阅读者也能清晰文档的更新历史 。 版本更新的内容包括版本号、修订人（当然版本的修订人）、修订时间（当前版本的修订时间）、修订内容（当前版本修改 ， 新增或删除了那些内容）、备注（对当前版本的一些附加说明）等 。


推荐阅读


上一篇：美股研究社Uber允许居家办公至明年6月，员工可获500美元家庭办公室津贴

下一篇：穿搭|这也能上热搜？江疏影这招有点厉害