DevOps文章之 操作手册用户使用说明书

前言

最近主导了几个项目操作手册的编写。有新开发的项目,要重新编写操作手册;有中途接手别的项目,后来功能迭代,需要更新原操作手册;有客户对操作手册有意见,需要调整;零零散散写了数万字的手册。

其实写操作手册或者叫用户使用说明书可以当作一个需求来处理。既然是需求,那么处理需求的几个主要步骤对于产品经理来说就是轻车熟路了。

  1. 明确需求的目的
  2. 明确目标用户
  3. 明确使用场景
  4. 形成解决方案
  5. 最小代价验证方案
  6. 调整并完善方案(编写文档到这一步就可以结束了)

明确编写目的、目标用户、使用场景

编写目的:操作手册就是介绍系统如何操作。对于交付型的项目,在交付的时候需要有这个文档。对于to B的项目,一般也会为客户提供该文档。即便目前有多种为用户介绍系统如何使用的方式,但是这个手册作为一个全面、详细的文档,在一些场景下还是有必要的。

目标用户:客服人员、系统用户(注意可能会有多个角色,比如管理员、操作员、被管理人员等)。

使用场景:客服人员多是软件的开发方的人员,当系统大到一定程度后,一些详细的规则单靠记忆很难覆盖,在遗忘的时候可以拿操作手册作为参考。一个是软件的实际使用人员,在遇到问题又找不到客服时,可通过操作手册进行快速查找。综合来看主要时两个场景:一、从头开始认识一个功能。二、查找某个功能的某一步的详细规则。

形成解决方案

针对编写目的、用户、场景,总结出操作手册必备的几个要素。一、明确的目录结构,既能让用户对系统有个整体全面的认识,又能方便用户查找;二、功能概述,根据目录的划分,对功能进行简要介绍,说明这个功能是干什么的;三、详细操作步骤,介绍每一步该怎么做,有什么注意事项。

目录结构

一般操作手册会根据不同的人有不同的版本,但是如果为每个人单独写一份,这个工作量就太大了。最好在写的时候就按使用人来划分,这样就可以只写管理员(拥有系统全部权限)版本,然后将管理员版本中的部分摘出来即可形成多个版本。比如一个系统有移动端和PC端,如果PC端作为管理、配置功能,给操作员用。PC端是展示,给管理者用,那么目录可以分移动端和PC端,然后再分更细的功能;如果同一个用户既可以在移动端完成该功能,又可以在PC端完成,那么目录可以按照功能进行划分。按照这样的逻辑划分就可以达到上述目的。

如果系统目录划分比较清晰,详细的功能可以按照目录来划分。这里to B系统的产品经理应该很熟悉。如果不清晰,建议先优化系统目录。或者系统功能本身很琐碎,操作手册可以按照事项来划分。比如某项信息要在前端展示,需要经历信息的上传、审核、发布等流程。那么既可以分开介绍某各流程具体怎么操作,也可以将信息怎么发布作为一个模块来整体介绍,或者写一个整体的流程框架,具体某步骤参照某章节。具体写法需根据系统的实际情况来判断。

功能概述

功能概述的目的是让手册使用者(很可能对系统完全不了解)对某个功能有一个整体的认识,知道为什么又这个功能,这个功能是干什么的,通过哪些步骤可以完成相关功能。可以让其它业务线的小伙伴来看你的描述,如果一看就懂,说明写的不错。没看懂的话可以与其进行沟通,看疑问的点在哪里,有针对性的调整描述。

可以如果流程较为复杂,可以用流程图等来辅助说明。

详细操作步骤

每一步具体怎么操作,点击哪个按钮,填写哪些字段。各个按钮点击有什么效果,字段填写有什么意义会影响到哪里。这些内容该怎么写,主要是根据页面和功能的种类。比如列表页,如果都是些根据名称能知道含义的字段,那么就不需要介绍。如果有些容易混淆的词,比如“更新时间”是只有用户在当前页面对数据修改进行记录,还是在其它页面做修改,导致该页面的数据产生变化时也做记录。这时候需要说明,否则用户在使用过程中会进行大量的提问。如果系统有专有名词,也需要进行描述。(最好单独用一小节对其进行统一介绍)

图片是操作手册的重要部分。但不能把系统上的图直接放在操作手册中。有几个需要注意的点:一是圈出每个步骤需要点击的按钮的位置。二是标明第一步点击哪里第二步点击哪里。做到这两点已经很清晰了。在大量的实践中,我发现最好把同一个功能里的几个步骤做一个长图,这样在文档中查看时不会形成大量的空白部分,能够更快的看出每个步骤是什么。如果客户没有看操作手册,直接问,客服可以把长图给他。

验证并完善方案

小范围发布

写好后,可以让公司其它小伙伴看一下,最好是目标用户。比如你手册的目标用户是运维,可以找其它产品线的运维伙伴来看。比如你的目标用户是客户,可以先小范围发给典型客户或关系较好的客户,收集问题,对操作手册进行调整。这个类似于产品的初步验证,用草图、原型各种能让用户理解体会到产品流程的方式,对产品进行初步的体验并提出意见。

根据反馈进行调整

目标用户对操作手册的反馈主要有两个方面。一个是用户的直接反馈,一个是用户的使用方式。

用户阅读手册后,可以与用户沟通使用意见,看哪里不容易理解,哪里查看起来不方便,以此来调整手册的结构及表达方式。另外可以观察用户如何查阅手册,看针对几个特殊场景(初次使用时的整体阅读及查询某个细节时寻找解决方法)的使用情况,来发掘文档可能存在的优化点。这个相当于既要通过访谈的方式沟通用户对产品的意见,又要通过观察的方式找出用户在使用中遇到的问题。

几点经验

版本管理

首先有一个操作手册基线版本,在第一次写完后记录当前操作手册对应的系统版本。然后根据系统的升级情况,会逐步往操作手册中增加内容,此时需记录每次都增加了哪些内容,对应了系统的哪些版本。因为系统更新后不一定每次都有时间立即更新操作手册,而且当操作手册的规模大到一定程度,再去核对手册跟系统的区别,将耗费大量的时间且操作起来极其繁琐。

可在手册中增加一个小节对此进行专门记录,写明手册版本、更改人、更改时间、更改内容。如有必要可增加审核人及审核时间。

明确/申明概念

将系统中特有名词进行解释。这些内容在系统设计之初应该有相关描述,可根据需要进行摘录。明确了概念才能顺畅沟通,而且很多问题本身也是不知道概念才产生的。

格式统一

主要是为了方便阅读。查看起来文档美观,查找相关内容也比较方便。写之前先定好规范,审核文档时作为审核项。修改文档前先看一下其它章节,不至于每次增加内容有用新的格式。文档格式主要有下面两种。

  1. 文档格式。文档标题、正文、表头等内容格式统一。
  2. 表达格式。比如描述按钮时统一用【】,描述系统提示时统一用“”等等,这个在手册内统一即可。

其它形式的操作手册

  1. 页面内的提示文字
    对于容易产生疑问的地方,用简短的提示文字解释。可以直接写在页面上,也可以增加小图标,点击后查看提示;根据提示的重要程度进行设计。文字一定要简短易懂。
  2. 常见问题解答
    这个模块可在操作手册中增加,也可以在系统中提供相关页面。系统中提供页面的优势在于随时可查看,而且可以根据用户当前的页面,将与页面相关的问题排在前面。
  3. 视频
    通过录制视频进行讲解,相对于文字更容易理解,可作为操作手册的补充。
  4. 简化系统的操作逻辑。

最好的操作手册是不用操作手册用户上手即会用。操作手册是系统的一部分,那么手册的理想状态是没有手册。通过优化系统、将提示融入系统等等方式可向这个理想艰难前行。

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

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

相关文章

智慧自助餐饮系统(SpringBoot+MP+Vue+微信小程序+JNI+ncnn+YOLOX-Nano)

一、项目简介 本项目是配合智慧自助餐厅下的一套综合系统,该系统分为安卓端、微信小程序用户端以及后台管理系统。安卓端利用图像识别技术进行识别多种不同菜品,识别成功后安卓端显示该订单菜品以及价格并且生成进入小程序的二维码,用户扫描…

P3647 题解

文章目录 P3647 题解OverviewDescriptionSolutionLemmaProof Main Code P3647 题解 Overview 很好的题,但是难度较大。 模拟小数据!——【数据删除】 Description 给定一颗树,有边权,已知这棵树是由这两个操作得到的&#xff1…

Stable Diffusion 模型下载:RealCartoon-Pixar - V8

文章目录 模型介绍生成案例案例一案例二案例三案例四案例五案例六案例七案例八案例九案例十下载地址模型介绍 这个检查点是从 RealCartoon3D 检查点分支出来的。它的目标是在整体上产生更多的“皮克斯”风格。我非常喜欢3D卡通的外观,希望能够创建出具有

无人机动力系统高倍率锂聚合物电池介绍,无人机锂电池使用与保养,无人机飞行控制动力源详解

无人机电池使用及保养 电池是无人机飞行的动力来源,也是一个消耗品,对电池充分了解,采取正确的使用方法,妥善进行维护保养将有助于提高飞行的安全性、延长电池的使用寿命。以下将详细对电池的使用和管理进行讲解。 高倍率锂聚合物电池的含义…

【MySQL】:深入理解并掌握DML和DCL

🎥 屿小夏 : 个人主页 🔥个人专栏 : MySQL从入门到进阶 🌄 莫道桑榆晚,为霞尚满天! 文章目录 📑前言一. DML1.1 添加数据1.2 修改数据1.3 删除数据 二. DCL2.1 管理用户2.2 权限控制…

华为配置交换机KPI信息上报分析器示例组网图形

配置交换机KPI信息上报分析器示例 组网图形 图1 KPI信息上报拓扑图 组网需求操作步骤配置文件 组网需求 如图1所示,某企业网络用一台华为公司iMaster NCE-CampusInsight作为分析器对交换机设备进行智能运维管理。iMaster NCE-CampusInsight与交换机之间已经实现路由…

Ajax+JSON学习二

AjaxJSON学习二 文章目录 前言三、前后端数据交互3.1. GET请求3.2. POST请求3.3. jQuery 中的 Ajax3.4. Ajax 的替代品:fetch3.5. 小结 四、JSON4.1. JSON简介4.2. JSON 语法规则4.3. JSON的解析和序列化 总结 前言 三、前后端数据交互 3.1. GET请求 GET 请求一般用…

【Golang】定时任务Cron指南-毫秒级任务支持

文章目录 CronCron快速使用时间表达式最小分钟级任务最小秒级任务预定义的时间表 时区Job选项Job 包装器WithLogger 支持毫秒级任务 Cron 版本:v3.0.0 仓库:https://github.com/robfig/cron cron是golang实现定时任务比较好的库, 这个库提供了一个简单而…

Tomcat 原理分析

1、Tomcat 的组成 如下图: Tomcat组成 Server: Tomcat 封装的、对外提供完整的、基于组件的 web 服务,包含 Connectors、Container 两个核心组件,以及多个功能组件,各个 Service 之间是独立的,但是共享 同…

MoE-LLaVA:具有高效缩放和多模态专业知识的大型视觉语言模型

视觉和语言模型的交叉导致了人工智能的变革性进步,使应用程序能够以类似于人类感知的方式理解和解释世界。大型视觉语言模型(LVLMs)在图像识别、视觉问题回答和多模态交互方面提供了无与伦比的能力。 MoE-LLaVA利用了“专家混合”策略融合视觉和语言数据&#xff0…

B2075 幂的末尾(洛谷)

复制Markdown 展开 题目描述 a的b次方的末 3 位数是多少? 输入格式 两个正整数 a,b。1≤a≤100,1≤b≤10000。 输出格式 从高位到低位输出幂的末三位数字,中间无分隔符。若幂本身不足三位,在前面补零。 输入输出…

【笔记】Helm-5 Chart模板指南-8 命名模板

命名模板 此时需要越过模板,开始创建其他内容了。该部分我们会看到如何在一个文件中定义 命名模板,并在其他地方使用。命名模板(有时称作一个部分或一个子模板)仅仅是在文件内部定义的模板,并使用了一个名字。有两种创…

打印斐波那契数列

定义: 斐波那契数列是指这样一个数列:1,1,2,3,5,8,13,21,34,55,89……这个数列从第3项开始 ,每一项都等于前两项之和。 …

2402d,d引入新的勾挂降级

原文 我正在试为ArrayLiteralExps添加一个降级模板.它应该调用_d_arrayliteralTX1.我在expressionsem.d中引入了以前的所有降级,并打算通过在此处添加它来同样处理该降级. 但是,ArrayLiteralExps比其他式更挑剔,因为编译器干了许多优化,并最终创建了额外的ArrayLiteralExps或…

各种能源折标准煤参考系数

各种能源折标准煤参考系数Conversion Factors from Physical Units to Coal Equivalent能源名称平均低位发热量折标准煤系数EnergyAverage Low Calorific ValueConversion Factor原煤20 908千焦/(5 000千卡)/千克0.7143千克标准煤/千克Raw Coal20 908 kjoule/(5 000 kcal)/kg0.…

k8s-项目部署案例

一、容器交付流程 在k8s平台部署项目流程 在K8s部署Java网站项目 DockerFile 如果是http访问,需要在镜像仓库配置可信任IP 三、使用工作负载控制器部署镜像 建议至少配置两个标签 一个是声明项目类型的 一个是项目名称的 继续配置属性 资源配额 健康检查 五、使…

GraphicsMagick 的 OpenCL 开发记录(三十四)

文章目录 如何写ScaleImage()的硬件加速函数&#xff08;八&#xff09; <2022-05-05 周四> 如何写ScaleImage()的硬件加速函数&#xff08;八&#xff09; 我觉得Y方向的缩放以下面这种ScaleFilter()的方法是实现不了的&#xff0c;我只能添加进X方向的处理&#xff0…

【集合系列】HashMap 集合

HashMap 集合 1. 概述2. 方法3. 遍历方式4. 代码示例15. 代码示例26. 注意事项 其他集合类 父类 Map 实现类 LinkedHashMap 集合类的遍历方式 具体信息请查看 API 帮助文档 1. 概述 HashMap 是 Java 中的一种集合类&#xff0c;它实现了 Map 接口。HashMap 使用键值对存储数据…

手动汉化unity编辑器,解决下载中文语言报错问题

手动汉化unity编辑器&#xff0c;解决下载中文语言报错问题 START 最近在下载支持微信小程序版本的编辑器时&#xff0c;中文语言包&#xff0c;一直无法下载。记录一下 手动汉化unity编辑器的方法 &#xff0c;帮助和我遇到同样问题的人。 解决方案 1. 下载汉化包 https:…

ubuntu22.04@laptop OpenCV Get Started: 005_rotate_and_translate_image

ubuntu22.04laptop OpenCV Get Started: 005_rotate_and_translate_image 1. 源由2. translate/rotate应用Demo3 translate_image3.1 C应用Demo3.2 Python应用Demo3.3 平移图像过程 4. rotate_image4.1 C应用Demo4.2 Python应用Demo4.3 旋转图像过程 5. 总结6. 参考资料 1. 源由…