互联网产品说明书指南,附撰写流程与方法

2023-10-27 02:25:13 字數 1431 閱讀 8849

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

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

首先,在写作的原则上,我认为,在写作产品说明书时,应秉持“对外行把事情讲清楚”的写作原则。

外行”,是指我们需要站在不懂业务的新人的角度来写作;“事情”,是产品说明书需要描述的内容,包括产品的结构、功能与界面;“清楚”,是我们写作要实现的目标。

例如,可通过helplook撰写产品说明书,能“清楚”地了解了“事情”,这样的产品说明书,才是详细表述了产品功能的产品说明书,才能够真正帮助产品新人了解产品,其对产品业务知识的传承功能才能得以实现。

其次,在写作方法与流程上,基于helplook创建产品说明书,并通过产品说明书(以下简称为“产品说明书”)完整的写作流程应该包含以方面:

helplook支持切换富文本(new)/富文本/markdown编辑器,有以下两种方法:

在文档编辑页面富文本(new)/富文本/markdown编辑器。如图,点击页面左上角即可选择切换编辑器。

富文本编辑器(new)为最新推出的编辑器,有合并**、查找替换、多种表情等高级功能。

在设置页面切换富文本(new)/富文本/markdown编辑器。如图,点击左侧菜单栏”设置“,点击站点设置->站点信息->默认编辑器,即可切换,完成后点击”保存“。

内容组织分类。

对产品具有的各个功能,按照mece原则(mutually exclusive collectively exhaustive,即“相互独立,完全穷尽”)进行分类汇总后加以描述,具有至少三个好处。

第一,它能有助于作者与读者从整体上把握产品的业务;

第二,通过将性质相同、具有内在联系的业务放在一起,能更有利于作者理解与挖掘业务之间的潜在联系;

第三,通过分类汇总,而不是简单的堆积罗列,能更有利于作者安排与组织文档的结构。

关于上述互联网产品说明书指南我就简单介绍这么多,大家也都可以按照helplook这款工具来撰写流程与方法,更高效率的完成产品说明书撰写。

禁止电子产品进校园,“互联网 教育”如何发展?

禁止电子产品进校园,互联网 教育 如何发展?王营。全国人大代表 贵溪市樟坪畲族乡乡长雷燕琴曾向全国人大提交 关于禁止中小学生在校园使用智能手机的建议 雷燕琴在 建议 中介绍,随着智能手机在未成年群体中的广泛普及,中小学生在校使用智能手机已经扰乱了正常的教学秩序,而学校的一些管理措施也受到学生及家长的...

互联网理财产品发展至今,存在何种风险?

年中国互联网理财用户规模达到了.亿人,占网民总数的. 而在年月份,这一数字已经突破了亿人,占网民总数的. 可以说,互联网理财已经成为了中国人民的一种重要的理财方式。那么,互联网理财产品有哪些呢?一般来说,可以分为以下几类 储蓄类产品。这类产品主要是指银行或第三方支付平台提供的余额宝 微信理财通等货币...

工业互联网产业联盟2023车载时间敏感网络TSN白皮书

今天分享的是车载时间系列深度研究报告 工业互联网产业联盟车载时间敏感网络tsn 报告出品方 工业互联网产业联盟 报告共计 页。报告 见鹿报告 车载网络现状 随着电控系统的日益复杂,以及汽车内部控制功能电控单元相互之间通信需求的日益增长,采用点对点的连接会使得车内线束增多,如图所示,同时考虑内部通讯的...