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

news2024/11/20 20:40:46

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

产品说明书

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

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

“外行”,是指我们需要站在不懂业务的新人的角度来写作;

“事情”,是产品说明书需要描述的内容,包括产品的结构、功能与界面;“清楚”,是我们写作要实现的目标。

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

撰写说明书工具

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

HelpLook支持切换富文本(New)/富文本/Markdown编辑器,有以下两种方法:

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

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

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

③内容组织分类

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

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

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

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

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

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1137689.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

洗衣行业在线预约小程序+前后端完整搭建教程

大家好哇,好久不见!今天源码师父来给大家推荐一款洗衣行业在线预约的小程序,带有前后端的完整搭建教程。 目前,人们对生活品质的追求不断提高,但生活节奏却也不断加快。对品质的追求遇到了忙碌的生活节奏,…

天锐绿盾终端安全管理系统

所谓透明,是指对使用者来说是未知的。当使用者在打开或编辑指定文件时,系统将自动对未加密的文件进行加密,对已加密的文件自动解密。文件在硬盘上是密文,在内存中是明文。一旦离开使用环境,由于应用程序无法得到自动解…

web安全-原发抗抵赖

原发抗抵赖 原发抗抵赖也称不可否认性,主要表现以下两种形式: 数据发送者无法否认其发送数据的事实。例如,A向B发信,事后,A不能否认该信是其发送的。数据接收者事后无法否认其收到过这些数据。例如,A向B发…

动态规划(记忆化搜索)

AcWing 901. 滑雪 给定一个 R行 C 列的矩阵,表示一个矩形网格滑雪场。 矩阵中第 i 行第 j 列的点表示滑雪场的第 i 行第 j 列区域的高度。 一个人从滑雪场中的某个区域内出发,每次可以向上下左右任意一个方向滑动一个单位距离。 当然,一个人能…

git更新代码时显示“auto-detection of host provider took too long“移除方法

git更新代码时显示"auto-detection of host provider took too long"移除方法 问题描述 在windows操作系统,未连接互连网电脑,更新内网代码库时显示“auto-detection of host provider took too long (>2000ms)”,如下图所示。…

idea 中配置 maven

前文叙述: 配置 maven 一共要设置两个地方:1、为当前项目设置2、为新项目设置maven 的下载和安装可参考我之前写过的文章,具体的配置文章中也都有讲解。1、为当前项目进行 maven 配置 配置 VM Options: -DarchetypeCataloginternal2、为新项…

设将n(n>1)个整数存放在一维数组R中。设计一个在时间和空间两方面都尽可能高效的算法。将R中保存的序列循环左移P(0<P<n)个位置

设将n&#xff08;n>1&#xff09;个整数存放在一维数组R中。设计一个在时间和空间两方面都尽可能高效的算法。将R中保存的序列循环左移P&#xff08;0<P<n&#xff09;个位置。即将R中保存的数据由&#xff08;x0,x1…,xn-1&#xff09;变为&#xff08;xp,xp1…x0,x…

vscode下ssh免密登录linux服务器

vscode使用ssh免密登录linux 1、安装SSH插件2、生成密钥3、linux安装ssh服务4、linux下配置公钥5、vscode远程登录 注&#xff1a;测试环境为window10Ubuntu1804/Ubuntu2204 1、安装SSH插件 扩展->搜索SSH->点击install进行安装&#xff0c;如下图所示&#xff1a; 2、…

【Linux】安装部署Redis

个人简介&#xff1a;Java领域新星创作者&#xff1b;阿里云技术博主、星级博主、专家博主&#xff1b;正在Java学习的路上摸爬滚打&#xff0c;记录学习的过程~ 个人主页&#xff1a;.29.的博客 学习社区&#xff1a;进去逛一逛~ Redis安装部署linux 1.gcc编译环境2.c库环境3.…

记src-Juniper

一、hunter搜索web.title”Juniper Web Device Manager”&#xff0c;查找到香港的一处资产。 二、访问相关网页&#xff0c;界面就是Juniper登录界面。 三、根据编号为CVE-2023-36845的利用方法&#xff0c;抓包&#xff0c;修改提交方式&#xff0c;成功读取到文件。 原始包…

09. 主频和时钟配置

09. 主频和时钟配置 硬件原理图分析7路PLL时钟源时钟树简介内核时钟系统主频设置CCM_CACRRCCSRCCM_ANALOG_PLL_ARMn代码实例 PFD时钟设置PLL2的4路设置PLL3的4路设置代码实例 AHB、IPG和PERCLK根时钟设置AHB_CLK_ROOT 和 IPG_CLK_ROOTPERCLK_CLK_ROOTCCM_CBCDRCCM_CBCMRCCM_CSC…

Redis | 数据结构(02)SDS

一、键值对数据库是怎么实现的&#xff1f; 在开始讲数据结构之前&#xff0c;先给介绍下 Redis 是怎样实现键值对&#xff08;key-value&#xff09;数据库的。 Redis 的键值对中的 key 就是字符串对象&#xff0c;而 value 可以是字符串对象&#xff0c;也可以是集合数据类型…

创建并启动华为HarmonyOS本地与远程模拟器及远程真机

1.打开设备管理器 2.选择要添加的手机设备,然后点击安装 3.正在下载华为手机模拟器 4.下载完成 5.创建新模拟器 下载系统镜像 点击下一步,创建模拟器 创建成功 启动模拟器 华为模拟器启动成功 6.登陆华为账号并使用远程模拟器 7.使用远程真机

论环境如何影响我们的一切

本心、输入输出、结果 文章目录 论环境如何影响我们的一切前言相关书籍极大影响我们的潜在客观环境环境带给我们的影响是如何进行具象化的大的框架体系是什么弘扬爱国精神论环境如何影响我们的一切 编辑:简简单单 Online zuozuo 地址:https://blog.csdn.net/qq_15071263 如果…

每日一练——返回链表的中间结点

&#x1d649;&#x1d65e;&#x1d658;&#x1d65a;!!&#x1f44f;&#x1f3fb;‧✧̣̥̇‧✦&#x1f44f;&#x1f3fb;‧✧̣̥̇‧✦ &#x1f44f;&#x1f3fb;‧✧̣̥̇:Solitary-walk ⸝⋆ ━━━┓ - 个性标签 - &#xff1a;来于“云”的“羽球人”。…

数据库扫描工具scuba

目录: Scuba的简单介绍 Scuba的安装 :Windows安装 、Linux安装 Scuba的扫描及结果分析 一、什么是Scuba? Scuba是一款网络安全扫描工具,而非数据库扫描软件。Scuba支持对Web应用程序、操作系统、网络协议等进行扫描,以发现潜在的安全漏洞和风险,并提供详细的扫描结果报告…

VM及WindowsServer安装

目录 一.操作系统的简介及常用的操作系统 二.windows的安装 安装VMWare虚拟机 注意点一 ​编辑 注意点二 三.安装配置Windows Server 2012 R2 四、虚拟机的环境配置及连接 1. 主机连接虚拟机 2. 虚拟机环境配置及共享 3. 环境配置 一.操作系统的简介及常用的操作系…

心理咨询医院预约和挂号系统

源码下载地址 支持&#xff1a;远程部署/安装/调试、讲解、二次开发/修改/定制 系统分为&#xff1a;患者端、医生端、管理员端。 患者端 医生端 管理员端

基本的设备使用

一.微步的态势感知 经常使用的 威胁---实时监控 里面有重要信息 里面有威胁名称 还有攻击类型 威胁--告警主机 查看主机威胁 webshell 查看打到webshell 调查---攻击者分析 平台管理 ---审计日志 2.防火墙 华为 usg6000 策略---黑名单 风塔防火墙…

JVM相关面试题(每日一练)

1. 什么是垃圾回收机制&#xff1f; 垃圾收集 Garbage Collection 通常被称为“GC”&#xff0c;它诞生于1960年 MIT 的 Lisp 语言&#xff0c;经过半个多世纪&#xff0c;目前已经十分成熟了。 jvm 中&#xff0c;程序计数器、虚拟机栈、本地方法栈都是随线程而生随线程而灭&a…