产品说明书写法指南 互联网产品说明书怎么写

优秀的在线用户手册 , 可以更好的辅助上网 。
用户了解产品 , 同时还可以教他们如何有效地使用产品功能 。作为制作者-应尽可能的保证用户能够轻松地阅读 , 参考和吸收信息 。
然而 , 如何保证读者已经吸收了所有的内容?下面小编为你提供7个写优秀在线用户手册的有效步骤 , 推荐收藏 。
一、进行受众分析 在线用户手册应该为受众编写(那些将购买你的产品或服务并阅读在线用户手册的人) 。受众分析将告诉你谁是你的主要受众或目标受众 , 并将指导你的写作 。
与将使用您的设备的人交谈 。在受控条件下为测试用户提供设备的原型和在线用户手册的初稿 。征求这些测试用户对使用不明显或令人困惑的事物进行反馈 , 并根据此反馈将更改合并到用户手册中 。您永远无法取悦所有人 。编写手册以适合目标人群或最大的受众为主 。考虑受众的年龄和教育水平 , 以确定编写用户指南的最佳方法 。二、做任务分析 任务分析是识别和组织使用设备所需步骤的过程 。全面的任务分析将确定每个步骤所需的材料和设备 , 以及每个步骤可能的操作、错误和故障排除建议 。
三、参考其他产品的用户手册 在为您自己的产品编写手册之前 , 请检查其他有效的用户手册 。注意结构 , 选词 , 句式 。苹果、谷歌、微软等各大品牌都制作了强大有效的用户手册 , 可以帮助你写出更有思想的用户手册 。
阅读您要出售的类似产品的手册 。例如 , 如果您要销售婴儿用品 , 请阅读婴儿手册 , 而不是技术手册 。四、确定在线用户手册的布局 优秀的在线用户手册需要易于浏览 。第一次接触的人会对自己需要的信息感到很舒服 , 回来的用户也能很快找到具体的内容和话题 。
您可以通过战略性地规划内容来确保您的用户手册是适用的 。简而言之 , 这意味着安排所有的培训材料 , 并以一种合乎逻辑的方式组织它们 。
对用户手册中的主题进行组织和分类 。您可以通过以下方式组织它们:
快速入门 最新动态 常见问题 产品/服务介绍确定在线用户手册的布局
五、如何布局内容 本节是在线用户手册的主要部分 , 应提供如何使用本设备的详细信息 。从使用设备的基本准备开始 。继续逻辑编号的步骤 , 这些步骤描述了设备的使用方式以及用户在正确使用设备时期望得到的反馈(例如 , “您将听到咔嗒声……”) 。
最好用图像和文字来说明一些步骤 。考虑使用用户手册中的照片或插图 。请确保包括有关不当使用或操作的相关安全警告 。例如 , 您可能会警告电锯的使用者在服用某些药物时不要喝酒或使用电锯 。如果您认为用户会从中受益 , 请考虑添加指向在线视频的链接 , 这些链接可演示设备的正确使用和操作 。您可以在本节的开头添加这些视频 , 也可以在每个步骤的末尾添加(对于仅说明一个步骤的视频) 。六、提供提供精准有效的搜索功能 【产品说明书写法指南 互联网产品说明书怎么写】上面我们提到过 , 在线用户手册是内容的聚合 , 仅仅对一个内容进行分类是不够的 。增加准确有效的搜索功能 。这一方面解决了人的惰性问题 , 另一方面也提高了用户的效率 。
在我看来 , 结构化内容是给初学者看的 , 因为他们不知道要找什么 。搜索功能更受老用户欢迎 , 因为他们知道自己要找的问题是什么 , 搜索设置可以帮助他们更快地找到内容 。在提高用户效率的同时 , 也维护了用户的好感 。
具体功能提示搜索功能准确 , 界面清晰 。
提供准确有效的搜索功能 。
七、注意用户的反馈不断优化内容 在线用户手册需要随着产品更新迭代和收集的用户反馈不断优化 。如果你发现一个用户手册很久没有更新了 , 那就说明这个产品可能又要走下坡路了 。这里强调一下 , 帮助文档不是面子工程 。如果建设得好 , 会给产品带来很大的优化和提升 。
对于具体功能的实现 , 建议在每篇文章的底部添加用户反馈功能插件(有用的或者没用的) 。或者直接放一张反馈表给用户使用 。通过反馈数据观察 , 还可以看到用户手册的使用情况 , 以及用户对产品的态度 。


推荐阅读