产品说明书,对于普通产品而言,再常见不过。药物、电器、电子产品等产品在正式出售时,往往都会附带一份产品说明书,以此告诉用户这个产品的功能与特性,并指导用户如何来使用这个产品。
产品说明书
那么,对于现在的互联网产品而言,它们是否同其他产品一样,也需要一份产品说明书呢?答案是是的,互联网产品也需要产品说明书。
首先,在写作的原则上,我认为,在写作产品说明书时,应秉持“对外行把事情讲清楚”的写作原则。
“外行”,是指我们需要站在不懂业务的新人的角度来写作;
“事情”,是产品说明书需要描述的内容,包括产品的结构、功能与界面;“清楚”,是我们写作要实现的目标。
例如,可通过HelpLook撰写产品说明书,能“清楚”地了解了“事情”,这样的产品说明书,才是详细表述了产品功能的产品说明书,才能够真正帮助产品新人了解产品,其对产品业务知识的传承功能才能得以实现。
撰写说明书工具
其次,在写作方法与流程上,基于HelpLook创建产品说明书,并通过产品说明书(以下简称为“产品说明书”)完整的写作流程应该包含以方面:
HelpLook支持切换富文本(New)/富文本/Markdown编辑器,有以下两种方法:
①在文档编辑页面富文本(New)/富文本/Markdown编辑器。如图,点击页面左上角即可选择切换编辑器。
*富文本编辑器(New)为最新推出的编辑器,有合并表格、查找替换、多种表情等高级功能
②在设置页面切换富文本(New)/富文本/Markdown编辑器。如图,点击左侧菜单栏”设置“,点击站点设置->站点信息->默认编辑器,即可切换,完成后点击”保存“。
③内容组织分类
对产品具有的各个功能,按照MECE原则(Mutually Exclusive Collectively Exhaustive,即“相互独立,完全穷尽”)进行分类汇总后加以描述,具有至少三个好处。
第一,它能有助于作者与读者从整体上把握产品的业务;
第二,通过将性质相同、具有内在联系的业务放在一起,能更有利于作者理解与挖掘业务之间的潜在联系;
第三,通过分类汇总,而不是简单的堆积罗列,能更有利于作者安排与组织文档的结构。
关于上述互联网产品说明书指南我就简单介绍这么多,大家也都可以按照HelpLook这款工具来撰写流程与方法,更高效率的完成产品说明书撰写。