本文说明
本文对锦中公司旗下的产品的操作手册的编写进行统一要求。锦中公司旗下所有的产品的用户手册的编制均应遵循本文档的要求、规范。
概要说明
用户操作手册的编写，没有固定的要求。不同的产品其用户手册的要求不一样，甚至同一个产品，不同模块的用户手册要求也不一样。
比如，对于“报销管理模块”，应当详细注明报销流程，但对于“在线提建议”则不需要注明流程，而是应当注明谁将会收到建议，是否会回复等。
操作手册的目的是为了让用户在遇到操作问题时，能够找到答案，减少向锦中的客服人员、工程师咨询的频率。
参考文档
锦中ObjectPlus开发手册：http://doc.jzkg.cn/p/objectplus-bladex/ （可能需要访问码，请到锦中OA中检索，或者咨询管理员）
阿里云在线帮助文档： https://help.aliyun.com/
Coding帮助中心：https://help.coding.net/
华为云帮助中心：https://support.huaweicloud.com/
编制要求
操作手册的部署方式
操作手册可能以Pdf的方式供用户下载，但更多的时候应当统一存放在“锦集网”（http://doc.jzkg.cn/），供用户在线浏览。
整体概述
每个产品的操作手册均应当有“概述”模块，“概述”只是笼统的说法，可能有的手册中叫“产品简介”，有的叫“序言”等，具体由手册编写人决定。
模块概述
具体页面模块的帮助手册
具体页面模块的帮助手册文档，没有具体的格式要求，因为软件系统的多样性，也很难统一标准，下面笔者总结了一些优秀的帮助文档，并列出这些文档的优秀之处，供用户手册的编写人参考。
优秀原因：
- 描述了“为什么需要此模块”
- 有“小提示”，可以把“小提示”理解为用户可能遇到的问题，或者用户可能需要了解事情。
- 有详细的过程描述，如调用接口验证、移除缓存。
- 图文并茂
优秀原因：
-在最上方有描述，如下图所示
- 有创建项目的详细步骤说明
- 对“项目管理员”所拥有的权限有详细的说明，如下图所示
- 图文并茂，并且描述简单、扼要、清晰
- 示例3，https://support.huaweicloud.com/basics-ecs/ecs_01_0102.html 和 https://support.huaweicloud.com/qs-ecs/ecs_02_0011.html
优秀原因：
- 结构清晰、明确。
- 步骤详细。
- 图文并茂。
其它注意事项
- 关于截图（Logo及系统名称）
在编制用户手册时，经常需要截制软件系统的界面图形。在截图时，不要以给某个客户试用的软件系统的图片。举例来说，锦中迎新管理系统，给A学校部署使用之后，A学校将系统左上角的Logo图片，换成了A学校自己的Logo。在编制手册时，不能截取A学校的系统界面，而应当由锦中工程师再重新部署一套通用的、仅供演示用的系统，用于编制手册。
- 关于截图（数据的准确性及友好性）
在截图时，有数据的界面上（如表单、列表页等），应当尽量将数据填写准确、完整、优美，尽量避免出现：Test、测试、aaabbb、111111 等测试数据。
- 在软件系统的操作界面中已有详细说明的，在用户操作手册中不要重复说明。
如下图所示，是某软件系统中申请License的界面，在“产品安装电脑/服务器的Ipv6地址”输入框后面已有详细的说明，那么在用户操作手册中，就不需要再对该输入框进行详细描述，原因如下：
- 软件系统中已有描述，无需重复描述；
- 软件系统界面随时有可能微调，微调之后，将导致操作手册与界面不一致。
软/硬件配置要求
一般来说，对于“系统类”软件，硬件配置要求至少应当有服务器端配置要求和用户端配置要求。服务器端应当注明安装软件系统所需的硬件最低要求、硬件建议、软件要求。用户端应注明建议要求。
下文是锦中某管理系统的配置要求，仅供参考：
服务器端硬件最低要求
至少需要一台服务器（数据库和应用安装在同一台服务器上）
CPU：2.40GHz或以上，至少需要2核
内存：4G
硬盘：可用空间 80G以上
其它方面无特殊要求
最低要求仅供演示使用。
服务器端硬件建议要求
建议两台服务器，数据库和应用各一台服务器。
应用服务器建议配置如下：
CPU：2.40GHz或以上，建议8核
内存：8G
硬盘：可用空间 200G以上
数据库服务器建议配置如下：
（此处省略）
其它方面无特殊要求，建议根据使用用户数量酌情增减。
服务器端软件要求
操作系统：
Windows： Windows Server 2019（或以上版本）
Linux：Ubuntu 20.04.1 （或以上版本）
数据库：My Sql 8.0（或以上版本），或 Sql Server 2014（或以上版本）
其它：
Redis 7.0 （或已上版本）
用户端软件建议要求
浏览器：Chrome、Firefox、Safari、Edge等chrome内核的浏览器常规版本均可
操作系统：支持上述浏览器即可，对操作系统无特殊要求。