完整版通用文档编写规范

1、*“ *项目名称用户使用手册XXX公司二 O xx年 X 月文档修改记录版本号版本描述责任人日期备注V1.0初始编制XXXX2012-8-31版本号示例：V1.0、V2.0、V3.0、V4.0、V5.0XXX项目用户使用手册第一章引言41.1 关于本手册41.2 定义41.3 手册编写约定41.4 参考资料6第二章系统概述72.1 系统功能72.2 运行环境82.2.1 网络环境92.2.2 服务器端92.2.3 客户端102.3 系统流程简介10第三章 功能（子系统）1操作说明113.1 功能1功能描述113.2 用户界面113.3 操作步骤113.4 本部分功能的部署11第四章功能描述12

2、第五章用户操作问题及处理 13广州市信佰信息技术咨询有限公司第14页共13页第一章引言1.1关于本手册提示：简要说明这份文档及用途【编写实例参见如下：】本手册主要是对本系统的安装方法、主要功能及操作方法的全面介绍，使您深入 浅出地了解该系统，并能灵活、有效地应用该系统。本手册主要包括以下内容：1. 概述及参考信息（附录）2. 本系统的整体设计和功能介绍3. 如何利用本系统完成您指定的任务4. 怎样进行相关系统的安装、维护和管理，以及处理常见问题5. 如何对本系统进行设置本手册将本系统的维护管理进行详细阐述，使您在遇到应用难题时顺藤摸瓜就能 轻松解决，必要的“警告”和“举例”还会给您带来更多的惊

3、喜。附录部分为您提供 专业词汇和相关书籍，使您更加准确地了解本系统及相关的技术。还要提醒您注意的是，本手册中的页面图片只是列举的实例，可能与您在实际操 作时略有不同，但并无大碍，相信您能够灵活地应用本系统解决实际问题。1.2定义提示：对该文档所使用的专门用语进行定义序号术语名称术语定义121.3手册编写约定【编写实例参见如下：】为使手册更加简洁、明了，我们可以用简单的符号或词语代替部分文字描述:文字描述代替符号举例文字描述代替符号举例普通按钮或图形按钮【】确定按钮，可简化为：【确定】普通菜单项或树状结构菜单项单击文件菜单，可简化为：单击文件按下鼠标左键单击某一对象单击单击确定按钮，可简化为：单

4、击【确定】选中某一对象按下鼠标右键右击选中My Documents文件夹，按下鼠标右键，可间 化为：右击My Docume nts双击鼠标左键打开某一对象双击双击鼠标左键打开“picture ”文件，可简化为：双击picture ”连续选择菜单及其子菜单或树 状结构选择程序 广东省质监局代码管理系统文件、窗体或标签页a ?“引入凭证”页面窗体中的项下图窗体中的“源科目代码”可表示为源科目 代码输入信息用下划线输入admin用户名和*密码对话窗：系统弹出的、让用户选择下一步操作的小窗口，选择【确定】或者是【取消】按钮后，确定进行何种操作，如图所示：知送樺程交对象隣页对话框选择提兗对象执订方式审批

5、表单创建人7人部门角色对薪裘别图一 -1对话窗输入窗：系统弹出需要用户自行输入的窗口，单击【确定】后，将输入的内容保存到系统中，确定进行下一步的操作，单击【取消】按钮后，返回到原窗口。如图所示:图一 -2输入窗警告窗：系统弹出的警告窗口，提醒用户已经完成了某项操作或操作中存在问题，单击【确定】按钮返回到主窗口，如图所示：此机构代码对厘的数据井不存在- 1i腮图一 -3警告窗1.4参考资料列明制定本文档所参考的资料清单（包括项目的立项报告、合同或招投标文件；软 件开发计划；用户需求说明书；软件需求规格说明书；系统设计说明书；手册中引用 的其它资料、采用的软件工程标准或软件工程规范），说明其作者和

6、出版日期。序号资料名称作者日期出版单位12第二章系统概述2.1系统功能提示：综合性的描述主要的系统功能【编写实例参见如下：】人事信息化管理系统是整个数字化校园的关键系统之一，是校务管理系统的有机 重要的组成部分，与教务、科研、学工、研究生相协作，相辅相成，共同构成高校的 数字化校园构架。帮助学校更好的发挥人力资源的价值，全面整合校内与教职工人事 信息相关的资源，将校内的各种人事基础信息充分整合，为全校的管理信息系统提供 了重要的教职员工基础数据，实现人员变动管理、职称评定、工资管理、考勤管理、 日常事务处理的电子化、简单化、智能化，真正发挥信息数字化作用，解决信息孤岛 等问题。人事信息化管理系

7、统主要包括人事信息管理、人员变动管理、人力资源建设管 理、工资管理、高级人才管理、数据导入导出、报表及统计和日常事务管理等主要功 能。功能结构请参见下图：人事信息管理人员变动管理 人力资源建设管理人事信息化管理系统工资管理高级人才管理数据导入导出报表及统计日常事务管理图二-1功能结构2.2运行环境提示：列出本系统的最终用户的特点，充分说明操作人员、维护人员的教育水平和 技术专长，以及本的系统预期使用频度。这些是系统设计工作的重要约束。221网络环境提示：描述系统运行的网络环境，网络环境要求包括网络拓扑结构图【编写实例参见如下：】通通通通 通通通通通通通 通通通通通通通 通通通通通通通通通通通通

8、通通通通通通通通通通通通通通通通通通通通通 通通通通通通通通通通通通通通通通通通通通通通图2-2网络拓扑结构图2.2.2服务器端提示：描述服务器配置要求，包括硬件和软件方面，以实际生产环境下所使用的服 务器为准【编写实例参见如下：】硬件平台Sun E25K （2CPU，4G内存等详细配置）操作系统Solaris 9支撑平台WebSphere Applicatio n Server 6.1应用服务器WebSphere Applicatio n Server 6.1数据库Oracle Web ServerIBM HTTP Server 2.0223客户端提示：对客户端机器运行的配置

9、要求，包括硬件和软件【编写实例参见如下：】硬件平台CPU 1.5GHz以上，内存512M以上，硬盘空间 20G以上等详细配置。操作系统XP操作系统Web浏览器In ternet Explorer V6.0 Service Pack 1 (Service Pack 2 for Microsoft Win dows XP)Firefox V 0 或以上版本2.3系统流程简介提示：采用流程图的形式，简要将系统总体流程和框架介绍清楚。流程图统一用VISIO绘画。第三章功能(子系统)1操作说明3.1功能1功能描述提示：采用结构图，流程图简要描述本功能模块功能和作用等。3.2用户界面提示：采

10、用屏幕截图的方式，将本功能用户界面清晰说明。3.3操作步骤提示：采用序号1), 2), 3),的方式，将本功能每一步骤详细描述操作的细 节和步骤，并需要结合业务需求来描述。3.4本部分功能的部署提示：本项为可选项，如果本部分功能可以单独部署或安装，则需要单独描述包括 服务器和客户端部分的部署和安装方法。第四章功能描述提示：本章和第三章,如果还有多个功能（或子系统）则需要再分几章第五章 用户操作问题及处理提示：描述用户操作过程中可能出现的问题及解决方法，以及对业务需求的理解错 误出现的操作错误以及补救措施。【编写实例参见如下：】1、安装有ISA1的计算机不能访问In ternet，而其他计算机通

11、过设置ISA1作为代理 服务器可以连接上网？【原因】由于没有建立安装了 ISA的计算机访问In ternet的规则，导致无法访问In ternet。【解决措施】由于我们使用的单网卡模式，经我们自己实验和与微软工程师沟通了 解到，在单网卡模式中只需要建立“内部”到“内部”的策略就可以保证所有计算机 的上网。”2、Websense不能下载内容数据库更新。显示 Authentication Error或者Connection Error，但是已经在ISA中设置了 Websense到ISA的所有通讯？【原因】根据 Websense官方文档，Websense更新程序使用的是“基本”身份验证 方式，而ISA默认的是集成验证，所以导致了这个问题。【解决措施】 在ISA管理界面中选择 配置一网络，在中间面板中选择 内部，右键 属性，选择 Web代理选项卡，点击 身份验证，选中 基本，确定。3、在英文版操作系统上安装 SQL Server2005中文版时，新建数据库提