行业新闻
互联网产品说明书怎么写(产品说明书写法指南)
2022-03-02 08:11  浏览:0

出色的在线用户手册,可以更好的辅助互联网用户了解产品,同时还可以教他们如何有效地使用产品功能。作为制作者-应尽可能的保证用户能够轻松地阅读,参考和吸收信息。

但是,如何确保读者将所有内容都吸收了呢?以下小编为大家提供了,编写出色的在线用户手册的7个有效的步骤方法,建议收藏。

一、进行受众分析

在线用户手册应该是为受众而写的(那些将购买您的产品或服务并阅读在线用户手册的人)。受众分析将告诉您,您的主要受众或目标受众是谁,并将指导您的写作。

  • 与将使用您的设备的人交谈。在受控条件下为测试用户提供设备的原型和在线用户手册的初稿。征求这些测试用户对使用不明显或令人困惑的事物进行反馈,并根据此反馈将更改合并到用户手册中。
  • 您永远无法取悦所有人。编写手册以适合目标人群或最大的受众为主。
  • 考虑受众的年龄和教育水平,以确定编写用户指南的最佳方法。

二、做任务分析

任务分析是识别和组织使用设备所需步骤的过程。全面的任务分析将确定每个步骤所需的材料和设备,以及每个步骤可能需要的操作,错误和故障排除建议。

三、参考其他产品的用户手册

在为您自己的产品编写手册之前,请查看其他有效的用户手册。注意结构,单词选择和句子风格。苹果,谷歌和微软等主要品牌制作了功能强大而有效的用户手册,可以帮助您编写更周到的用户手册。

  • 阅读您要出售的类似产品的手册。例如,如果您要销售婴儿用品,请阅读婴儿手册,而不是技术手册。

四、确定在线用户手册的布局

出色的在线用户手册需易于浏览。第一次接触它的人会发现自己需要的信息感到很自在,并且回头的用户能够快速找到特定的内容和主题。

您可以通过策略性地计划内容来确保您的用户手册适用。简而言之,这意味着布置所有培训材料并以合乎逻辑的方式进行组织。

对用户手册中的主题进行组织和分类。您可以通过以下方式组织它们:

  • 快速入门
  • 最新动态
  • 常见问题
  • 产品/服务介绍

确定在线用户手册的布局

五、如何布局内容

本部分是在线用户手册的主要部分,应提供有关如何使用该设备的具体详细信息。从使用设备的基本准备工作开始。继续进行逻辑编号的步骤,这些步骤描述了设备的使用方式,以及用户正确使用设备时期望得到的反馈(例如,“您会听到喀哒声……”)。

  • 最好用图像和文字来说明一些步骤。考虑使用用户手册中的照片或插图。
  • 请确保包括有关不当使用或操作的相关安全警告。例如,您可能会警告电锯的使用者在服用某些药物时不要喝酒或使用电锯。
  • 如果您认为用户会从中受益,请考虑添加指向在线视频的链接,这些链接可演示设备的正确使用和操作。您可以在本节的开头添加这些视频,也可以在每个步骤的末尾添加(对于仅说明一个步骤的视频)。

六、提供提供精准有效的搜索功能

上面我们也讲到,在线用户手册作为一个内容的聚合体,光做好一个内容的分类还是不够的。得加上一个精准有效的搜索功能。这样一方面解决了人的惰性问题,二方面提升了使用者的效率。

在我看来结构化内容是给新手使用的,因为他们不知道要要找什么问题。搜索功能呢更受老用户青睐,因为他们知道要找的问题是什么,通过搜索的设置则能帮助他们更快的找到内容。提高用户效率的同时,也将用户的好感度维系起来。

具体功能的实现上建议搜索功能精准,界面清晰。

提供提供精准有效的搜索功能

七、注意用户的反馈不断优化内容

在线用户手册需要随着产品的更新迭代、收集到的用户反馈不断做优化。如果你发现一个用户手册很久都没更新那代表这个产品可能再走下坡路了。这里在重点强调下帮助文档不是面子工程,把它建设好了会给产品带来巨大的优化和推动作用。

具体功能的实现上建议在每篇内容下面,添加用户反馈的功能插件(有用无用)。或者直接放一个反馈表单供用户使用。通过反馈的数据观察也能看到用户手册的使用量,和用户对于产品的态度。

注意用户的反馈不断优化内容

好了以上就是小编总结的编写出色用户手册的7个有效的步骤,觉得有用的话可以收藏起来。结尾小编给大家讲下在线用户手册的搭建工具,如果想搭建的可以看看哦!

Baklib

网址:http://d5wz.cn/mciz

这款工具的特点是易于分享,使用Baklib编辑的用户手册可通过域名分享观看,所有的内容会在一个网站中进行展示。

Baklib不仅为企业与个人提供了好用的知识整理平台,还提供了优质的知识发布平台,将整理出来的产品文档通过Baklib,即可让所有客户都能在线观看,帮助他们对产品的理解,为用户使用提供便利。

特色功能

易于编辑:采用块状的编辑器,所有的内容包括文本、图片、视频、表格、Markdown等内容皆为模块,可以自由拖拽重组,不再依赖传统的顶部工具栏,而是通过模块插入菜单、快捷编辑菜单、格式转换菜单等方式唤起,使得用户的编辑体验更专注。

剪藏插件:使用“剪藏插件”可以将网上的内容收藏到Baklib站点当中,排版格式将会保留下来。不仅能做到全文保存还可以选取其中的段落。可对之前已有的在线文档内容进行迁移。

丰富的展现样式:Baklib提供了15+可自定义页眉页脚的主题,让用户手册更具观赏性。同时可添加独立域名。

权限设定人性化:当需要对用户手册进行协作和分享时,可以对编辑人员和观看人员进行权限设置,权限界限分明。

数据安全:除了文件导入外,还支持整个站点的数据导出。

Baklib

语雀

网址:https://www.yuque.com/

这是阿里巴巴开发的在线文档工具,孵化自蚂蚁金服。已是 5万+ 阿里员工进行文档编写、知识沉淀的标配。制作使用简单,编辑器功能强大,唯一的缺点是只有一个简单的展示主题,美观性上不是太好。但其他的都挺棒的!

语雀

特色功能

密码管理:可对文本加密,安全性做到极致。作为一只忘性大的运营狗,要在多种自媒体中切换,账号和密码让人头痛,用语雀的这个功能,将各个平台的账号密码保存在一个文本中,加密保护,再记住这个密码就好了。

插入格式丰富:除了图片、表格等,还支持视频、公式、附件、思维导图以及代码块,程序猿们的福音。

知识库:这是个宝藏功能,在知识分享库里,可以看到各种干货和大佬的经验,随时随地在线充电。

写作工具:这个知识输出功能丝毫不输有道云笔记、印象笔记,而且界面简洁,还支持Markdown语法。

总结

2020年了,如果作为企业管理人员还在一个劲的只想打磨产品,忽视用户使用体验,那无疑是一条腿走路。而在用户手册的设置,是最切实有效且成本最低的方法