软件用户手册编制规范样本.doc

顾客手册编制规范

版权声明
《顾客手册编制规范》版权归XXX软件公司所有。未经XXX软件公司书面准许，不得将本规范任何某些以任何形式、采用任何手段(电子或机械，涉及照相复制或录制)、或为任何目，进行复制或扩散。
(c)Copyright XXX软件公司。版权所有，翻制必究。
是XXX软件公司注册商标。
Microsoft、word是Microsoft Corporation注册商标。
Windows是Microsoft Corporation商标。

前 言
顾客手册对于任何产品都是不可缺少构成某些。一种好产品没有一份完备顾客手册，也不能算作一种完备产品。对于软件产品来说更是如此，没有顾客手册软件不能算产品，没有好顾客手册，就不也许算好产品。也就是说，一种好软件产品除了具备与市场对路思想、良好顾客界面、完备测试之外，还必要有一本适合顾客使用顾客手册。
本规范手册不但指明了软件顾客手册内容，并且规定了XXX软件公司软件顾客手册统一版面、格式。本规范手册就是按本规定编写，但由于本规范手册内容局限性，很难以样本形式体现软件顾客手册中也许浮现各种状况，因此请人们认真阅读本规范手册内容。
咱们但愿XXX软件公司有关人员，可以按照本规范手册编写自己软件顾客手册，做好咱们软件产品化工作。由于时间仓促，编者水平有限，但愿人们可以提出宝贵意见，以逐渐完善本规范手册内容。

阅读指南
〖手册目的〗
本手册重要对XXX软件公司软件产品顾客手册所应包括内容及版面格式作一种初步统一规定。由于实际状况千变万化，本规定很难一次做到面面俱到，需要逐渐完善。
〖阅读对象〗
本手册是为XXX软件公司所有软件开发人员和软件顾客手册编写人员所编写。由于本手册中格式规定某些是依照 Microsoft Windows 下 Word 功能而编写，因此XXX软件公司软件顾客手册应当使用 MicroSoft Word排版。
〖手册构成〗
本手册基本上由两某些构成：
1. 第1章，“关于顾客手册排版格式规定”，规定了顾客手册标题及编号格式。
2. 第2章，“顾客手册内容”，规定了顾客手册所应包括内容较为详细清单。
此外，本手册基本上是按“顾客手册格式统一规定”编写一种样本。
〖手册商定〗
本手册遵循如下商定：
1. 所有标题均使用黑体字。
2. 如果标题后跟有“〖条件〗”字样，阐明该标题下正文所规定内容是在一定条件下必要。
【注意】意思是请读者注意那些需要注意事项。
【警告】意思是请读者千万注意某些事项，否则将导致严重错误。

目 录

第1章 顾客手册格式规定 1-1
§1.1 标题及编号 1-1
§1.1.1 章标题设立 1-1
§1.1.2 节标题设立 1-1
§1.1.3 小节标题设立 1-1
§1.1.4项目符号和编号设立 1-2
§1.1.5 其他编号设立 1-3

§1.2 正文及页眉页脚排版 1-4
§1.2.1 正文排版 1-5
§1.2.2 版面设立 1-5
§1.2.2.1 版面设立 1-5
§1.2.2.2 关于页眉、页脚设立 1-5
§1.2.2.3 注意与警告 1-5

第2章 顾客手册内容 2-1
§2.1 顾客手册目的 2-4
§2.2 顾客手册内容 2-4
§2.2.1 封面 2-4
§2.2.2 二封 2-4
§2.2.3 版权声明 2-4
§2.2.4 前言 2-4
§2.2.5 阅读指南 2-5
§2.2.6目录 2-5
§2.2.7基本知识简介〖条件〗 2-5
§2.2.8 系统安装及启动 2-6
§2.2.9 系统操作阐明 2-7
§2.2.9 1 CAD软件 2-7
§2.2.9 2 其他软件 2-9
§2.2.10 系统及数据维护 2-9
§2.2.11 例题〖条件〗 2-10
§2.2.12 各种附录 2-10
§2.3 顾客手册风格 2-11

第1章 顾客手册格式规定
§1.1 标题及编号
普通状况下，顾客手册用章、节来划分其内容，必要时还可引入小节、小小节概念。
§1.1.1 章标题设立
每章编号用阿拉伯数字表达，采用“第1章”、“第2章”、……形式表达章编号，章编号背面空一种半角格，然后是这一章标题。
1. 章必要另起一页开始打印。
2. 章编号和标题采用左对齐格式放在行左边，左缩进为0。
3. 章编号和标题中中文采用黑体小三号字，章编号和标题总长度不能超过一行。
4. 章编号和标题行距取最小值、12磅，段前、段后分别取24磅。
§1.1.2 节标题设立
节编号格式为“§x.y”。其中，x为章号码，y为节号码，用阿拉伯数字表达。节编号背面空一种半角格，然后是这一节标题。
1. 原则上每一节另起一页开始打印，但对于每章第一节，如果章标题下无阐明文字，可以将其与章标题放于一页之中。
2. 节编号和标题采用左对齐格式放在行左边，左缩进为0。
3. 节编号和标题中中文采用黑体四号字，节编号和标题总长度不能超过一行。
4. 节编号和标题行距取最小值、12磅，对于与章标题处在同页要将其段前、段后均取12磅，否则段前取24磅、段后取12磅。
§1.1.3 小节标题设立
小节编号格式为“§x.y.z”。其中x为章号码，y为节号码，z为小节号码，用阿拉伯数字表达。小节编号背面空一种半角格，然后是这一小节标题。
1. 小节不必另起一页开始打印。
2. 小节编号和标题采用左对齐格式放在行左边，左缩进0.74CM。
3. 小节编号和标题中中文采用黑体小四号字，小节编号和标题总长度不能超过一行。
4. 小节编号和标题行距取最小值、12磅，段前取12磅。
【注意】
1. 如果有必要，还可以在小节下面划分更小节，咱们暂且称之为小小节。
2. 对于小小节各种规定与小节一致，为保持版面清晰，小小节不再相对于小节向右缩进。
3. 在顾客手册中，系统提示信息采用幼圆五号字，别的所有数字及字母采用Arial字体，字号与相应中文相似。在本规范中提到字体如无特殊注明，均指中文字体。
4. 顾客手册中，行距均取最小值、12磅。
§1.1.4 项目符号和编号设立
在章、节、小节、小小节里面均可以具有项目符号和编号。
1. 编号
1) 编号序列相对于与之相应标题向右缩进0.74CM。
2) 编号格式是“n.”，其中n为阿拉伯数字。
3) 对于有名编号序列名称采用五号黑体中文，其背面内容采用五号宋体中文；对于无名编号序列中内容字体同有名编号序列。
4) 编号序列里还容许采用二级编号序列，其格式规定如下：“n)”，其中n为阿拉伯数字。
5) 二级编号相对于与之相应一级编号向右缩进0.74CM。
6) 其他规定和一级编号序列一致。
7) 编号及二级编号行间距取最小值，12磅。一级编号第一项段前取12磅，别的各项及二级编号段前均取6磅。
2. 项目符号
1) 项目符号相对于与之相应标题或编号序列向右缩进0.74CM。
2) 项目符号格式是“Ÿ”，其中“Ÿ”字体为Wingdings，五号字。
3) 对于有名项目符号序列，名称采用五号黑体中文，其背面正文采用宋体五号字，对于无名项目符号序列中内容字体同有名编号序列。
4) 如果项目符号序列处在编号序列下级，则各项各项段前均取6磅；否则首项段前取12磅，别的各项段前取6磅。
【注意】项目符号和编号下论述文字相对于与之相应项目符号或编号向右缩进0.74CM，首行缩进0.74CM，段前取6磅。中文字体取宋体五号。
§1.1.5 其他编号设立
1. 页编号：顾客手册中正文按章进行编号，其格式为“章-页”。如，第2章第3页，编号为“2-3”。页编号放在页脚中，详细设立办法详见“页眉、页脚设立”。
2. 图、表编号：
顾客手册中图、表均按章分别进行编号，其格式分别为“图x-y”、“表x-y”。如，第2章第3幅图编号是“图2-3”；第2章第3张表格编号是“表2-3”。在图表编号背面空一种半角格，然后是这一图表名称。此外，还规定：
1) 表编号与名称放在表顶部。
2) 表编号与名称和表左对齐，而整个表则居中放置。
3) 表编号与名称段后取6磅。
4) 图编号与名称放在图底部。
5) 图编号与名称和图均居中放置。
6) 图编号与名称段前取6磅。
7) 图前面正文段后取12磅。
8) 图、表编号与名称中中文采用黑体五号字。
§1.2 正文及页眉、页脚排版
§1.2.1 正文排版
正文排版涉及字符排版、段落排版、图形排版和版权声明、目录等排版，本节就这几方面格式规定加以详细阐述。
1. 字符排版：
1) 顾客手册正文，系统提示采用幼圆五号字体，别的采用宋体五号字。
2) 对于界面中按钮名称，应把按钮名称用“〈〉”括起来，按钮名称用黑体五号字书写。对于下拉菜单选项名称，应用“”引起来，选项名称用宋体五号字书写。对于热点，应用“”引起来，热点名称用黑体五号字书写。
3) 正文均采用常规字体、原则位置、原则间距。
2. 段落排版：
1) 正文段落首行相对于与之相应标题或编号序列向右缩进0.74CM。
2) 行距采用最小值，12磅，除项目符号及编号以及图形前面正文按前面所述特殊规定进行排版外，别的段前均取12磅。
3) 采用两端对齐方式。
3. 图形排版：
1) 屏幕截图时，应使所截图片尺寸为最大。
2) 对于尺寸较大图片，可使图片高度和宽度按同比例恰当缩小。
3) 必要时可恰当缩小或将图片移到下一页，以保证图片与图号及图名在同页。
4) 当正文中对图标进行阐明时，应使图标同与之相应标题对齐。
5) 为保证页面清晰，可恰当调节图标右侧阐明文字行间距以及段前、段后。
6) 在屏幕截图时，图片中输入数据不能包括我司员工真实姓名。
4. 版权声明、目录等排版：
版权声明、前言、阅读指南、目录标题为段前取36磅，段后取24磅，采用黑体小三号字；内容排版与手册正文排版相似。
§1.2.2 版面设立
§1.2.2.1 版面设立
对于版面设立作如下规定：
1. 纸张大小：顾客手册用纸统一规定为16开。
2. 页边距：上：30mm；下：20mm；内侧：21mm；外侧：16mm。此外采用“对称页边距”；对于版面设立页眉、页脚应选用“首页不同”和“奇偶页不同”。
3. 对于新项目或新产品可依照详细状况对版面设立恰当做某些修改。
§1.2.2.2 关于页眉、页脚设立
1. 页眉设立：
1) 版权声明、前言、阅读指南、目录均无篇眉。
2) 章编号和名称所在页篇眉为一行有50%填充边框。
3) 对于单号页，页眉内容是当前章标题名，规定打印在纸右上角。
4) 对于双号页，页眉内容是顾客手册名称，规定打印在纸左上角。
5) 纸顶边与页眉距离是23mm。
6) 页眉中中文采用幼圆小五号字。
2. 页脚设立：
1) 页脚内容是当前页页编号，如第2章第2页为2-2。
2) 页编号字体采用Arial五号字。
3) 纸底边与页脚距离是13mm。
4) 版权声明、前言、阅读指南、目录页脚为ⅰ，ⅱ等，居中放置，不带边框。
§1.2.2.3 注意与警告
在顾客手册中，对于那些需要顾客特别注意事项，应当用“【注意】”作为标志给顾客以特别提示。关于注意标志和注意事项格式有如下规定：
1. 注意标志同与之相应标题对齐。
2. 注意标志采用黑体小四号中文。
3. 注意标志段前取12磅。
4. 如果注意事项只有一条，其内容应当紧跟在注意标志背面书写；否则，应当在注意标志下一行开始，采用编号序列形式分别给出。
在顾客手册中，对于那些会给顾客导致重大损失行为，应当用“【警告】”作为标志给顾客以警告性提示。
【注意】关于警告标志和警告事项格式规定与关于注意标志和注意事项格式规定一致。

第2章 顾客手册内容
本章重要讨论编写顾客手册所要达到目的、软件顾客手册所应包括内容、以及在顾客手册编写过程中所应保持风格。
如果标有“〖条件〗”字样，阐明该某些内容是在一定条件下所必要。
§2.1 顾客手册目的
某软件评测中心把软件产品评测测试分为两个阶段——初评安装测试和复评测试。只有通过初评安装测试软件才干进入复评测试，初评安装测试内容涉及：
1. 按照软件顾客手册中安装阐明测试软件能否顺利安装成功。
2. 对照软件顾客手册测试软件功能与否与手册描述一致。
3. 评价产品包装及顾客手册与否符合商品化规定。
4. 通过以上三方面测试且无严重死机状况软件可进入复评测试。
由此，咱们可以看到软件顾客手册是一种软件产品基本，没有合格软件顾客手册就主线谈不上合格软件产品。另一方面，良好安装阐明及软件功能与手册描述一致性是对软件顾客手册两个基本规定。
咱们编写顾客手册要达到两个目：
1. 让顾客手册成为顾客学习使用咱们产品最佳教材。顾客通过阅读顾客手册，应当对咱们产品功能、操作有一定结识；按照顾客手册上阐明，通过实际操作，顾客应当可以掌握咱们产品操作过程。
2. 让顾客手册可以起到减少销售费用作用。顾客手册不但应当涉及咱们产品操作阐明，并且还应当涉及系统（软件和必要硬件）安装、数据维护、出错解决等。通过顾客手册，就可以让顾客掌握在使用咱们软件过程中浮现各种状况解决办法。
为达到这两个目的，在普通状况下，顾客手册应当包括如下几种方面内容：
1. 封面
2. 二封
3. 版权
4. 声明
5. 前言
6. 阅读指南
7. 目录
8. 基本知识简介〖条件〗
9. 系统安装(涉及必要硬件安装)及启动
10. 系统操作阐明
11. 系统及数据维护
12. 例题〖条件〗
13. 各种附录
【注意】如果本系统软件是一种大系统，其系统安装、操作阐明、系统及数据维护都相称复杂，则可以把这三个某些分别编写为一本甚至几本顾客手册，每本手册均有自己封面、版权声明、前言、阅读指南、目录以及相应基本知识简介和附录。
§2.2 顾客手册内容
§2.2.1 封面
封面内容应涉及公司ICON、软件名称及版本号、公司名称及手册印刷时间。
§2.2.2 二封
二封正面为软件名称及版本号、公司名称、手册印刷时间、公司地址及服务电话等。以EDD4.0手册为例，其形式如下：
EDD/AutoCAD R14 V4.0顾客手册
XXX软件公司
地址：沈阳市和平区三好街84-2号
电话：[phone] [phone]
传真：[phone] [phone]
客户服务热线：800-890-8000
Email：
§2.2.3 版权声明
版权声明是保护咱们所开发软件产权、不使咱们公司利益受到损害一种方式。在版权声明中应当涉及如下内容：
1. 对咱们所提供软件及顾客手册保护声明。
2. 对咱们软件及商标 所有权声明。
3. 对咱们顾客手册中所提到各种商标版权声明〖条件〗。
4. 咱们不对顾客由于使用咱们软件所导致损失负责声明。
详细请参照本规范版权声明。
§2.2.4 前言
对于前言所应包括内容经常依照顾客手册编写人员习惯不同而不同，有时仅仅包括了系统开发背景和目，有时还包括了系统简介，有时甚至还包括了顾客手册阅读指南。
为了统一起见，在这里咱们规定前言重要涉及如下内容：
1. 系统开发背景和目。
2. 系统所能应用领域和使用对象。
3. 系统功能及特性简介。
4. 如果本手册不是该系统第一种版本，还应当简介较上一版本改进某些。
§2.2.5 阅读指南
阅读指南是每本(套)顾客手册必不可少构成某些，顾客通过它可以理解到顾客手册基本内容；理解到应当如何、从哪儿开始阅读该顾客手册。顾客手册阅读指南应当包括如下几某些：
1. 手册目的：通过阅读该顾客手册，顾客应当或可以达到什么目的。
2. 阅读对象：指明什么人员应当阅读该手册，或什么人员应当阅读本手册哪些某些；阅读对象在阅读本手册之前应当掌握哪些知识，必要时应给出资料清单，以便顾客查阅。
3. 手册构成：如果本系统顾客手册(涉及管理员手册、参照手册)由几本构成，一方面应当分别简要简介这些手册状况。最主线是应当简介本手册在哪一章或哪几章解说了什么内容，对于较大系统，如Universal Office 3.5，分别简介每一章内容比较繁琐，则可概括性地简介。
4. 手册商定：这一某些应当涉及字体商定、特殊符号商定以及【注意】、【警告】、【阐明】等含义。必要时，应当给出某些基本术语定义。也可以把基本术语、概念定义作为基本知识来简介。
详细请参照本规范阅读指南。
§2.2.6 目录
目录编写要尽量详尽。如果顾客手册内容用到小节，则目录就应当编写到小节；如果顾客手册内容用到小小节，则目录就应当编写到小小节。编写顾客手册目录目就是为了让顾客可以依照它不久地找到想要内容。
关于格式请参照本规范目录编写。
§2.2.7 基本知识简介〖条件〗
这一某些内容是在一定条件下必须，顾客手册编写人员应当依照实际状况拟定与否需要这一某些。如果涉及基本知识简介，应将其放在第1章。
在普通状况下，使用咱们软件系统需要一定基本知识。这些知识可以从关于书籍上得到，但是顾客从这些资料得到这些知识需要耗费相称时间。在某些状况下，咱们只需要顾客掌握顾客手册中使用那些概念，那么咱们就有必要编写一章“基本知识简介”来进行专门简介。
例如说，在工厂管道设计系统顾客手册中，经惯用到按下鼠标“数据键”、“捕获键”、“复位键”概念，顾客虽然可以从《Microstation顾客手册》中得到这些概念，但是比较不以便。由于咱们编写顾客手册重要目的就是以便顾客，因此有必要在顾客手册一开始就简介这些概念。
§2.2.8 系统安装及启动
如果手册中涉及基本知识简介，应把系统安装及启动作为第2章，否则，将其作为第1章一方面向读者予以简介。
系统安装及启动某些应当涉及如下内容：
1. 系统运营环境
Ÿ 硬件环境规定阐明：系统运营时所需硬件环境描述。涉及机型、内存大小、硬盘空间等。如果必要，还应涉及输入/输出设备、通讯环境等。
Ÿ 软件环境规定阐明：系统运营时所需软件支持环境描述。涉及所需任何其他软件名称及版本号等。
Ÿ 其他环境规定阐明〖条件〗：应当阐明规定任何其他环境。
2. 系统安装
对于不同系统其安装应有所区别，普通来说，应给出最后顾客可以据此把软件安装到其操作系统并配备完毕，且能成功运营任何信息和操作。系统安装涉及软件安装过程及系统环境配备〖条件〗，必要时还应给出硬件安装〖条件〗。
Ÿ 硬件安装〖条件〗：如果必要，应当详细阐明系统所需硬件环境安装过程，其中涉及软件加密锁安装。
Ÿ 软件安装：
应当用图示办法详细简介软件安装过程。对于网络版软件，应对服务器端及客户端安装分别予以简介（可参照文档管理系统SEAS-AMS 5.0）。如果两者安装过程相似，可以详细简介一种，另一种参照前一种即可。如果软件由各种模块构成，且其中某些模块需单独安装，如Universal Office 3.5，则应分别给出安装环节。
所有产品安装涉及如下界面：安装快闪界面〖条件〗、安装初始窗口（欢迎）、版权声明界面、选取安装途径界面、选取程序文献夹（程序组）界面〖条件〗、安装进程界面〖条件〗及安装完毕界面。
Ÿ 系统配备〖条件〗：应给出系统配备详细过程，以便顾客可以顺利操作系统。对于网络版软件，应分别讲述服务器和客户端配备过程。
3. 系统启动：应给出系统启动办法。如果系统由各种模块构成，则不必单列出一节讲述系统启动办法，只须在简介各个模块操作时给出模块启动办法即可。
对于系统安装及启动构造总结如下，供编写顾客手册时参照：
|------系统运营环境 |----硬件环境
| |----软件环境
|
系统安装及启动 | |----硬件安装
|------系统安装 |----软件安装
| |----系统配备
|
|------系统启动
§2.2.9 系统操作阐明
系统操作阐明是所有顾客手册主体，它所包括内容相称广泛。重要涉及：输入命令和数据、软件功能、输出成果、出错信息及其矫正和恢复办法。
对于不同软件，其操作阐明也应有所不同，下面就几种状况分别予以简介。
§2.2.9.1 CAD软件
CAD软件操作阐明应涉及文献管理、图纸尺寸设立、图形绘制、图形编辑、尺寸标注、图层管理、图库调用〖条件〗、图库维护〖条件〗及附录〖条件〗等内容。
在顾客手册中应按操作顺序或界面中菜单顺序分别对上述内容中每一项操作予以简介。规定详细给出操作过程及命令格式与功能，详细规定如下：
1. 各种操作、命令和语言：软件系统使用过程都是使用软件系统提供各种操作、命令和语言过程。因此，咱们必要做到：
1) 操作和命令：在顾客手册中详细给出各种操作过程和功能、命令格式和功能；应当描述在使用上各种限制，如，操作状态、操作条件、操作序列等。此外，必要时可以通过恰本地举例讲述各种操作和命令用法，以协助顾客理解。
2) 输出信息：应当详细列出与操作、命令有关各种输出信息。如果输出信息意思自身不是很明显，应当予以解释。此外还应当阐明对于这些信息所采用操作。
3) 程序设计语言〖条件〗：如果咱们软件系统提供了某种语言，对其语言规则应当予以阐明。
2. 各种数据：在软件使用过程中，顾客必要与各种数据和信息打交道。为了让顾客可以操作咱们软件，咱们必要为顾客提供各种构造以及每个数据元素含义
有些数据适合在系统操作阐明中给出，有些适合在背面附录中给出，甚至有些除了在操作阐明同步给出外，还要在附录中予以归纳，这些都由顾客手册编写人员依照实际状况来决定。这些数据涉及：
1) 输入数据〖条件〗：应当给出数据内容、逻辑构造、格式以及每一种数据元素意思。如果输入数据依赖于某特定数据介质，则应当予以阐明。
2) 输出数据：应当给出软件以何种形式输出数据内容和格式，并规定以例样形式予以阐明。
3) 中间数据〖条件〗：如果咱们告诉顾客在软件运营过程中所产生中间数据内容和格式，有助于顾客理解软件使用，则应当予以阐明
4) 数据限制〖条件〗：如果对数据有限制，如数据大小限制，则应当予以阐明。
5) 数据文献〖条件〗：如果要告诉顾客咱们软件所使用某些数据文献构造有助于顾客理解咱们软件使用，则应予以阐明，但应当注意技术保密。如果对数据文献有所限制，例如每个文献最大记录数、每个磁盘最大文献数等，应当予以阐明。
3. 解决过程〖条件〗：如果咱们简要地给顾客描述咱们软件对顾客操作、输入命令和输入数据解决过程，有助于顾客理解咱们软件使用，则应予以阐明。
4. 截图内容：当前，多数软件已不再采用命令行输入方式，而是采用对话框输入方式。在此状况下，应当以图示方式对软件操作过程予以简介。采用图示方式讲述软件操作过程应注意如下几点：
Ÿ 所截图形输入、输出信息中不应包括我司人员真实姓名，且各种输入、输出信息以不泄漏公司机密为原则。
Ÿ 截图是为使论述更加明确、简洁，因此应尽量避免不必要截图。普通来说，在顾客手册中应当涉及系统主界面、各种操作初始界面（点取命令后弹出第一种界面，普通需要输入信息）、操作中间过程界面、操作成果界面以及其他某些必要界面。没有必要为下拉菜单、快捷菜单等内容截图，由于这些操作都比较简朴，只要用语言论述顾客即可明确其操作办法。此外，在同一本手册中，应避免重复截图，对于不同输入或输出信息同一界面在手册中不应重复（例题除外）。
5. 出错解决：应当给出各种出错状况以及相应解决办法。
6. 现对系统操作阐明环节总结如下，供编写顾客手册时参照：
1) 进入有关界面。
2) 调用命令（选取菜单、键入命令或点击工具按钮）。
3) 弹出相应操作初始界面（或提示行）。
4) 对输入信息予以阐明。
5) 继续操作（点击按钮或选取参数及键入按键等）。
6) 成果界面（或成果提示行）。
7) 对输出信息予以阐明。
【警告】在编写软件顾客手册系统操作阐明时，咱们在决定与否提供某种数据格式时，应以不泄漏公司技术并且有助于顾客使用为准则。
§2.2.9.2 其他软件
对于某些比较复杂软件，普通涉及各种模块。对于此类系统，规定按照操作顺序对各个模块分别简介。普通按模块提成若干章，在各章中对有关模块操作予以简介。对于此类软件操作环节总结如下：
1. 启动某一模块，进入该模块主界面。
2. 执行某一功能（选取菜单或工具按钮）。
3. 弹出有关界面。
4. 对输入信息予以阐明。
5. 继续操作（点击按钮）。
6. 成果界面。
7. 对输出信息予以阐明。
有些软件操作也许需要一定技术和经验才干获得满意成果，那么应当在顾客手册上尽量给出这些技术和经验描述，或告诉顾客如何才干获得这些技术和经验。例如，在操作SEAS系统作图纸净化解决时，如何选取恰当阀值就需要一定技术和经验。
某些比较简朴系统，如NetEye、OpenVideo等其系统操作比较简朴，操作阐明内容比较少。对于此类软件，手册中可以将操作阐明归纳为一章，再按操作顺序予以简介。
此外，对于各种操作、命令、语言、数据及截图内容规定同CAD软件。
§2.2.10 系统及数据维护
应当给出顾客数据备份、恢复、删除、整顿详细过程。如果必要，应当给出系统数据、系统磁盘空间维护详细过程。
§2.2.11 例题〖条件〗
有些软件系统可以通过一种较为完整例题演示系统某些功能用法，在这个例题中，顾客应当详细地描述每一步操作过程，顾客可以通过这个例题对系统操作有一种初步理解。
§2.2.12 各种附录
在顾客手册中，有些知识和信息可以通过附录形式提供应顾客，以便于顾客查阅，这些内容是：
1. 错误提示信息：普通可以以表形式按照一定顺序，例如按出错提示信息编号顺序、或按出错提示信息字母顺序，给出出错提示信息编号、提示信息、相应解释、出错因素和解决办法
2. 命令速查表〖条件〗：普通可以以表形式按照一定顺序给出各种命令概要(涉及命令名称、各种参数、及相应功能简介)，以协助有一定经验顾客进行迅速查找所需信息
3. 数据文献格式〖条件〗：可以通过附录简介顾客必要理解或可以理解各种输入数据文献、输出成果文献、中间数据文献格式、限制范畴、恰当解释等
4. 其他信息 〖条件〗：任何其他有助于顾客使用咱们软件、以便顾客信息都可以以附录形式提供应顾客
【注意】虽然附录所提供信息也许均可以在系统操作阐明中查到，但提供附录目就是为了以便顾客使用，这种重复还是必要。
§2.3 顾客手册风格
顾客手册应具备自己风格。有人喜欢用比较深奥概念和语言来阐明问题，有人喜欢用比较长句子来表达思想，在编制顾客手册过程中这些都是不可取。顾客手册应当具备如下特点：
1. 顾客手册句子尽量简洁：如果用一种句子表达起来比较复杂，定语多，则可以提成两个甚至几种句子来阐明，这样顾客在阅读顾客手册时会轻松些。
2. 每节、段内容明确：每节内容必要明确，这样顾客可以通过目录很以便地查到自己所需要内容；注意段划分，每段不要太长，突出重点，否则顾客不容易获得其中精华。
3. 顾客手册用词要先后一致：在顾客手册中使用概念、术语用词要先后一致，否则顾客将不容易读懂此手册。
4. 顾客不一定是计算机专家：顾客手册编写人员应当牢紧记住这一点，咱们大多数顾客都不是学计算机，手册中应当尽量不使用较深奥计算机术语。如果不可避免，咱们应当予以恰当解释和阐明。此外，不要觉得咱们顾客什么都懂，因此在编写顾客手册时候，应当详细地描述操作过程中每一步。
5. 顾客手册各某些风格应当统一：某些较大系统也许由多人开发和测试，如Universal Office 3.5，从而导致顾客手册各某些风格各异，这就规定顾客手册编排人员最后将各某些统一成风格相似一本手册。