互联网产品的产品说明书写作流程与方法

  • 内容
  • 评论
  • 相关

产品说明书,对于普通产品而言,再常见不过。药物、电器、电子产品等产品在正式出售时,往往都会附带一份产品说明书,以此告诉用户这个产品的功能与特性,并指导用户如何来使用这个产品。

那么,对于现在的互联网产品而言,它们是否同其他产品一样,也需要一份产品说明书呢?答案是是的,互联网产品也需要产品说明书。

一、互联网产品也需要产品说明书

首先,众所周知,互联网产品是快速迭代、高速发展的产品。一方面,产品新功能的增加与改进需要基于产品目前的现状来进行;另一方面,随着产品的不断发展,产品自身的业务功能、模块、逻辑与规则的复杂度也日益提升,使得产品现状不断发生变化,变得越来越复杂。因此,我们需要一份文档来系统地记载、描述产品的最新现状,使之成为该产品的产品基线,为产品后续的不断改造提供参考。

其次,互联网的从业人员也处于快速变更与流动的状态。对于新的产品与技术人员而言,需要一份文档来帮助他们快速地了解产品与业务的现状,或是对所遇到的业务问题进行查证。这也将使得产品业务知识的传承和持续成为可能。

产品说明书,正是能够满足上述两方面需求的文档。它是以文体的方式,对某产品的结构、功能与界面等特性进行的详细表述。它一方面作为产品基线,通过全面、准确地说明产品现状,为产品的后续开发提供标准与参考;另一方面,也能帮助产品新人或是对业务不了解的人快速了解或查证产品的业务。

既然互联网产品也需要产品说明书,那么,它与普通产品的产品说明书是否存在差别?当然存在。互联网产品的产品说明书在阅读对象、目标与侧重点方面都与普通产品的产品说明书不同。

二、互联网产品的产品说明书与普通产品的产品说明书存在差异

(1)阅读对象不同

互联网产品的产品说明书的阅读对象是产品研发团队的内部人员,包括产品的产品经理、交互与视觉设计师、研发人员、测试人员与客服人员等。而普通产品的产品说明书的阅读对象是产品的用户。

(2)目标不同

基于阅读对象的不同,产品说明书的目标也不同。互联网产品的产品说明书,是清楚、准确地描述产品的现状,包括产品现有的结构、功能(包括功能的规则与逻辑)与界面等特性,目标是为了供产品研发团队参考与查询。而普通产品的产品说明书,是为了告诉用户这个产品具有的功能,以及应该如何来使用这些功能。

(3)侧重点不同

不同的阅读对象、不同的目标,导致二者的侧重点自然也不同。互联网产品的产品说明书,侧重于说明产品功能的流程、规则与逻辑,尤其是需要清楚说明功能背后的业务背景与业务价值。而普通产品的产品说明书,侧重于描述产品的交互过程。

既然互联网产品需要产品说明书,且它与普通产品的产品说明书存在较大的差别,那么,应该如何来写作互联网产品的产品说明书(以下简称为“产品说明书”)呢?

三、互联网产品说明书写作流程与方法

首先,在写作的原则上,我认为,在写作产品说明书时,应秉持“对外行把事情讲清楚”的写作原则。“外行”,是指我们需要站在不懂业务的新人的角度来写作;“事情”,是产品说明书需要描述的内容,包括产品的结构、功能与界面;“清楚”,是我们写作要实现的目标。只有外行人员通过产品说明书,能“清楚”地了解了“事情”,这样的产品说明书,才是详细表述了产品功能的产品说明书,才能够真正帮助产品新人了解产品,其对产品业务知识的传承功能才能得以实现。

其次,在写作方法与流程上,我认为,产品说明书(以下简称为“产品说明书”)完整的写作流程应该包含以下四个步骤:

1.内容输入

产品说明书的内容输入,即是指在写作前和写作中,作者所搜集、整理的各种产品材料,是产品说明书的内容来源。它主要包括以下三个方面:

(1)PRD

作为最重要的一种产品文档,PRD即是产品说明书内容的重要来源之一。但是,在使用PRD时,应注意PRD与产品说明书的不同:

·两者的描述对象可能不同

PRD产出于产品开发之前,指导着产品开发的全过程。从理论上而言,RPD应该与产品开发保持同步,但是在实际产品工作过程中,PRD往往滞后于产品的开发进度,开发过程中的许多需求变更往往未能及时同步到PRD中。而产品说明书一定是描述产品最终的实现形态。因此,在作者接收PRD时,需要尽可能保证当前的PRD与产品最终的实现形态在大体上是一致的,例如,对变更的需求与功能进行了描述,删去这一期产品未实现的功能等。

·两者的阅读对象略有不同

PRD供产品开发的技术人员阅读,对产品功能的描述往往以需求的形式进行。而产品说明书的阅读对象除了内部的产品与技术人员,还包括产品与技术新人等不熟悉业务的人员。因此,产品说明书的文档表述,应该站在目标读者的角度上进行,保持产品功能的描述视角。

·两者的表述方式、详细程度不同

一方面,由于PRD没有明确的规范与格式,故其表述方式、详细程度均由各PD自身的写作风格决定;另一方面,PRD作为内部沟通工具,PRD未能描述清楚的问题均可以通过额外的沟通机制进行确认,因此,PRD对于一些问题的描述,可能不会非常清晰与透彻。而产品说明书的各个部分在表述方式与详细程度上应该有比较一致的标准,且应该尽可能“详细表述”产品的功能,做到“对外行把事情讲清楚”。

正因为PRD与产品说明书存在差异,因此,在作者理解PRD时,一定要确保自己的理解是准确无误的。要实现这一点,与PRD对应的产品经理保持紧密沟通,是最主要且最有效的方法。除此之外,积极参与相关PRD的评审、跟进PD的邮件通知等,也能提高自己对PRD的理解程度。

(2)亲身实践产品的功能

正如上文所说,PRD与最终的产品形态可能会存在较多的差异,且对功能的描述可能不会足够清晰与透彻,因此,亲身实践产品的各项功能,是产品说明书作者,了解产品的另一重要方法。在实践产品功能的过程中,作者除了关注产品的主流程,还应对产品的分支流程、异常流程等给予关注和实践。

(3)与相关业务人员进行沟通

对于PRD中有疑问的地方、实践产品功能的过程中发现的任何疑问点,都应该与相关的业务人员进行沟通和查证。这里的业务人员,除了产品经理,还包括产品的开发人员、交互与视觉设计师、测试人员与客服人员等。通过与各业务人员的沟通,作者能将产品分散的各个显性或隐性知识加以汇总,如此,产品说明书的内容来源将得以不断丰富和充实。

2.内容输出

内容输出,即是产品说明书初稿产出的过程。在作者写作产品说明书时,对以下几个方面需要给予关注:

(1)对产品功能进行分类汇总

对产品具有的各个功能,按照MECE原则(Mutually Exclusive Collectively Exhaustive,即“相互独立,完全穷尽”)进行分类汇总后加以描述,具有至少三个好处。第一,它能有助于作者与读者从整体上把握产品的业务;第二,通过将性质相同、具有内在联系的业务放在一起,能更有利于作者理解与挖掘业务之间的潜在联系;第三,通过分类汇总,而不是简单的堆积罗列,能更有利于作者安排与组织文档的结构。

(2)保持文档的一致性

保持文档的一致性,能使文档的内容表述更加准确与清晰,它包括以下方面:

·使用统一的说明模板

在描述每个功能时,使用统一的说明模板。例如,业务定义、业务介绍、业务规则与界面截图;或者,业务描述,业务流程图,业务规则说明等。

·业务名词的统一

保持业务名词在文档中的一致性。尤其是当产品涉及到多个业务域时,保持同一业务名词全称与简称的一致性,非常重要。

(3)文档的重点内容为功能的流程、规则与逻辑

对于产品的功能而言,相较于产品页面样式,功能本身的流程、规则与逻辑更为稳定,也更为核心。因此,产品说明书的重点内容,应为产品功能的流程、规则与逻辑,同时,以产品页面的截图作为辅助,加以说明。

(4)善用参见

通过参见,将文档中具有相互联系的功能联系起来。

3.校对与修改

在产品说明书初版产出以后,作者需要对文档进行校对与修改。对文档的校对包括两方面,一方面,是文档内容的校对。这部分的校对可通过与产品相关的各业务人员进行,通过熟悉产品的人的一并校对,可保证产品说明书的内容准确无误,不出现大的偏差;另一方面,是写作语法与表述上的校对,这一点,在写作其他语种(如英语)的产品说明书时,不可或缺。

通过校对与修改,能使文档内容更加准确、表述更为清晰与流畅,从而初步实现产品说明书的基本目标。经过多次的校对与修改,可形成产品说明书较为稳定的版本。

4.持续的更新

产品会不断保持更新。作为产品的详细表述的文档,产品说明书的更新也会持续进行。更新的流程将重复上述的三个步骤,并不断持续下去。

四、用产品工作的方法来写产品说明书

产出一份好的产品说明书,绝对不是一件容易的事。如果将产品说明书看做是一个产品,产品说明书的写作,也是一个产品定义、设计、实施与维护的过程,它同样包括产品功能与目标用户的定位(明确产品说明书的目标与读者)、产品功能设计(内容输入)、产品交互设计与产品开发(内容输出)、产品测试与发布(校对与修改)与产品的跟踪维护(持续的更新)。因此,产品工作中的很多方法,在产品说明书的写作中都是适用的,也希望本文所提及的思路与方法,能对你在写作产品说明书时,有所启示与帮助。

 

文/冰少(简书作者)


扫一扫与互动
  微信公众号码:kelebl
  微信公众号名称:科勒巴黎