最新公告
  • 欢迎您光临xd素材中文网xdsucai.cn,服务于广大UI设计师。立即加入我们
  • 如何写用户操作手册,说明文档需要注意哪些问题

    你是否开始写用户手册了。不知道如何开展用户操作手册的编写呢,最近找了很多资料参考,发现要写好一份说明文档要注意的事项还是挺多,下面分享一下我自己的感悟和心得。

    一、手册的背景

    先说一下手册的背景,便于大家的阅读和理解,我们的系统是刚刚落地的,为什么要写用户操作手册。

    一方面,项目刚刚落地,手册要发给对应的用户代表去查看,学习使用系统。

    另一方面,也是为了后续正常运营后,用户群体的学习和解惑文档。为什么要划分用户代表和用户群体呢,下面内容会讲到

    二、用户操作手册的基本要素

    各类手册的基本要素基本相同的,可以通用的。这里主要以我写的用户操作手册案例铺开做个描述。

    手册的基本要素主要包括以下五点。

    • 封面:包括公司logo、公司名称、软件名称、版本号;
    • 目录:功能模块名称、页码;
    • 修订记录:包括修改人、审批人、修改内容、版本号和修订时间;
    • 系统概述:项目背景、项目目标、应用的主流程;
    • 功能说明:模块划分、步骤说明、注意事项、内容说明、系统截图。

    主要通过以下两种分类说一下我对基本要素的理解。

    (1)用户认知

    文档的编写涉及到一个用户认知的问题,人的认知都是整体-局部-细节,粗略来分,系统概述是整体,用户可了解一个大概的概念,知道我们系统是做什么的。

    功能模块是局部,用户可了解基本流程和场景;功能说明是细节,告诉用户该怎么做。基本要素的配备主要符合一个人认知流程。

    (2)用户感知

    • 公司层面:主要是针对用户代表,在项目刚刚落地阶段,要想让用户代表重视我们的文档,更方便项目的推广,那在封面和系统概述上,要做到与用户代表共情;
    • 用户层面:用户层面也包括用户代表和用户群体,功能说明时要通俗易懂、内容简洁、导读性要强。

    1. 手册封面

    主要展示的内容是公司logo、公司名称、软件名称、版本号。

    • 公司logo、公司名称:这里涉及用户共情的问题,落地运营阶段,可以调动用户代表积极性(因为我们公司是集团旗下的公司,如果以我们公司的名义给手册命名下发,就用户心态来说,可能有些用户都不知道我们公司,那用户对我们的文档不会太重视;如果以集团的名称命名,那用户就更重视这份文档,更积极配合工作)。
    • 软件名称:相对多端多角色的软件来说,可以加上区别端名,eg:***家长端,***教师端。
    • 版本号:加版本号,主要是系统会不断的迭代,可以通过版本号,来区分手册的时效性。

    2. 修订记录

    修订记录主要是记录修改人、审批人、修订内容、版本号和修订时间。主要对于公司来说,可以通过修订记录,来查看版本迭代的内容是否已经即时更新。

    其次用户也可以通过这里的内容来了解我们更新的功能。

    3. 目录

    主要是增强用户的导读性,系统概述和功能说明的用户引导,可做内容模块的超链接,让用户可以快速定位到对应的模块。

    4. 系统概述

    主要包括项目背景、项目目标、应用流程,系统概述主要是让用户对我们的项目有个大致的了解,达到用户共情目的,可以通过项目概述去了解用户痛点是什么,我们是怎么去解决的,以及应用的主流程是什么,让用户更加有代入感。

    5. 功能说明

    主要包括模块划分、步骤说明、注意事项、内容说明、系统截图五个要素、要保证文本的导读性,尽量做到简洁易懂。

    • 模块划分:模块的划分有两种类型,按页面去划分和操作场景划分,个人偏向按操作场景划分,贴合用户的使用习惯,阅读起来更加易懂。

    eg :招生系统,基本的工作流程,记录咨询学生信息、确定报名学生的信息、生成学生的收费标准,那我们的操作场景就可以分三步,记录咨询学生信息>学

    生报名>生成学生的个人收费标准。

    • 步骤说明:写步骤说明要注意用户的代入感的问题,用语准确、概括、简洁。
    • 注意事项:主要说明针对错误步骤,或者异常步骤,提醒用户要怎么去解决

    eg:招生系统-学生报名,报名时,系统提示“该学生已存在“,是因为名字重复还是其他用户录入的原因,那就可以提醒用户去进行核对,去那里核对。

    • 内容说明:该功能点用户可以获得什么,可以做个补充 ,可以让用户阅读起来更加有代入感。

    eg:招生系统-学生报名,招生人员每给一个,学生报名就会统计到绩效里、这个可以激励用户,就可以做个内容补充。

    • 系统截图:系统的截图要注意两点,一点是截图要有重点内容的标示,用户一眼可知道该步骤讲述的功能按钮或内容模块;另一点,系统截图目前大部分的系统截图都是局部的截图,这里要注意截图是,要截该页面的主要特征,用户一看就知道这个页面在系统哪里。不要让用户花时间去找。

    三、用户操作手册更好的表现形式

    操作手册是详细描述软件的功能、性能和用户界面,使用户了解到如何使用该软件的说明,现在软件说明的方式多种多样,有智能客服,word文档、PPT,视频教程等。

    从信息传递来看,分为图文类和视频类,随着短视频的兴起,视频类的教程用户的接受程度会更加高,视频会比较直观,学习的成本比看文档的会更少,缺点是给用户的思考时间不会太长。

    对于一些复杂的逻辑内容,以图文的形式呈现给用户,更能给用户一个更好的思考环境。

    我们现在也在尝试视频教程和操作手册的去做结合,视频主要是针对不同的使用场景去做教程,图文手册主要是做全局的详细说明。

    xd素材中文网,提供优质的UI设计资源免费素材,有xd源文件,sketch源文件,设计规范,实用的商业ui设计教程。
    XD素材中文网 » 如何写用户操作手册,说明文档需要注意哪些问题

    常见问题FAQ

    关于我们
    我们是一家服务广大ui设计师的素材平台,提供包括UI、平面设计、ppt模版,网页素材、png素材、设计插件、设计软件等一些列优质资源免费分享给到设计师,有效提升工作效率。
    免费下载或者VIP会员专享资源能否直接商用?
    本站所有资源版权均属于原作者所有,这里所提供资源均只能用于参考学习用,请勿直接商用。若由于商用引起版权纠纷,一切责任均由使用者承担。更多说明请参考 VIP介绍。
    百度网盘为什么下载慢?
    国内只有在百度网盘放资相对靠谱,基本不会出问题,但百度网盘限制了非SVIP用户的下载速度和稳定性,不过使用百度云盘软件下载(不要用网页直接下载)会相对稳定,而且能断点续传;
    找不到素材资源介绍文章里的示例图片?
    对于PPT,KEY,Mockups,APP,网页模版等类型的素材,文章内用于介绍的图片通常并不包含在对应可供下载素材包内。这些相关商业图片需另外购买,且本站不负责(也没有办法)找到出处。 同样地一些字体文件也是这种情况,但部分素材会在素材包内有一份字体下载链接清单。

    发表评论

    • 62049会员总数(位)
    • 28003资源总数(个)
    • 141本周发布(个)
    • 0 今日发布(个)
    • 538稳定运行(天)

    提供最优质的资源集合

    加入会员 免费领会员