1、 四川托普集团技术文档 详 细 设 计 说 明 书 操作手册1前言11 系统标识提示：标识出软件系统全名、简称、标识符、版本、产品号等。1. 2 系统概述提示：简要陈述本软件系统的用途。简要介绍本软件系统所在领域的软件系统种类；简要概述软件系统开发、运行和维护的历史过程，指出本软件系统项目的承接方、接收方、使用者、开发者以及技术服务代理方等；还应指出当前或计划运行的地点以及其它相关内容。1. 3 手册说明提示：主要说明编写这份操作手册的目的，简要介绍手册的内容安排，还应有与本手册使用相关的安全方面的考虑。2软件概述21 软件适用范围提示:给出软件的潜在用户，功能的改进情况，使用本软件能达到的目
2、的。22 软件清单提示:列出全部软件文件，包括：软件运行必需的数据库和数据文件，还应描述每一文件的安全考虑以及紧急情况采用的安全恢复措施等。23 环境配置提示:列出软件操作所需的软硬件手册以及其它资源。主要有以下内容：a.计算机设备，包括：CPU 性能，内存大小，辅存容量，所需外围设备，如：终端、打印机、扫描仪。b.通讯设备。c.所需其它软件。如：网络软件、操作系统、数据库系统、工具软件（包括系统备份、恢复、安全所需的工具和文件等）四川托普集团技术文档 详 细 设 计 说 明 书 d.手工操作的流程应以插图的形式表示出来。e.其它。24 软件结构与操作简介提示:给出从操作员的角度来看的软件结构
3、及操作过程。主要有以下内容：a.以操作员的角度来看的软件的逻辑结构，每一组件的功能和操作介绍。b.列出软件对各种输入/访问的响应信息。c.列出软件的输出报告其它输出信息，以及它们的安全属性。d.列出软件的运行时间等性能参数。e.列出软件的操作框架。使用图表说明相关操作的分类及异同。如果软件系统运行操作按时间流程来分类，列出哪些操作是每天做的，哪些操作是每周做的等等；如果软件系统运行操作按逻辑结构的层次来分类，列出各个层次的操作要点。f.列出系统的限制，如：与其它系统的接口，数据规模等。g.列出系统的网络拓扑图，一般性描述软件的进程和通信函数(如果有的话)。25 状态描述提示:给出软件各种状态、
4、模式以及紧急情况下操作的异同。26 安全与许可提示:给出与本软件相关的安全与许可。如：关于本软件和相关文档非法使用或非 法拷贝的警告等。27 技术支持提示:给出在软件操作中遇到问题时，获得技术支持方式及手续等。3安装与初始化提示：一步一步地说明为使用本软件而需要进行的安装与初始化过程，包括程序的存储形式、安装与初始化过程中的全部操作命令，系统对这些命令的反应与答复，表征安装工作完成的测试实例等。如果有的话，还应说明安装过程中所需要到的专用软件。4运行说明提示：本章分以下几节给出软件的运行描述。对于安全性或关键步骤应用警告(WARNING)或小心(CAUTION)以及警示图标等符号表示出来。41
5、 运行列表提示：列出每种可能的运行，摘要说明每个运行的目的，指出每个运行各自所执行的程序。42 接口描述四川托普集团技术文档 详 细 设 计 说 明 书 提示：给出本软件提供的输入、输出接口，如：给出为其它系统使用的中间结果文件的格式，中间结果的人工、半人工检查方式和步骤等。43 诊断流程提示：给出每一软件子进程设置与执行的诊断流程。包括：有效确认和无效检测定位。还应诊断软件提供的输入、输出接口，如：给出为其它系统使用的中间结果文件的格式，中间结果的人工、半人工检查方式和步骤等。44 错误信息提示：列出软件给出全部错误信息的解释和处理办法等（如果信息量太大，可将本节放入附录） 。45 子进程
6、1 运行说明提示：把子进程 1 的有关信息，以对操作员最为方便最为有用的形式加以说明。451 运行控制提示：列出子进程 1 运行所需的作业工作流向控制说明。452 操作信息提示：给出操作和管理子进程所需的信息，主要有以下内容：a 运行目的；b 操作要求；c 启动方式，如：应邀启动、紧接上一个子进程启动、预定时间启动等；d 预计的运行时间和解题时间；e 操作命令；f 与运行相关的其它事项。453 输入/输出文件提示 ：提供被本子进程建立、更新或访问的数据文件的有关信息，主要包括：a 文件的标适符或标号；b 记录媒体；c 存留的目录表； d 文件的支配，如：确定保留或废弃的准则、是否要分配给其他接
7、受者、占有硬件设备的优先级以及安全保密控制等的有关规定；454 输出(报告) 文字段提示 ：提供本子进程输出的每一个用于提示、说明、或应答的文字段（包括“菜单“）的相应信息，主要有以下内容：a 文字段的标适符；b 输出媒体（屏幕显示、打印显示等） ；c 文字容量；d 分发对象；e 保密要求。455 输出(报告) 文字段的硬拷贝提示 ：提供由计算机产生，而又要以硬拷贝的形式存档备份或其它用途的有关信息，主要有以下内容：a 文字段的标适符；四川托普集团技术文档 详 细 设 计 说 明 书 b 复制的技术手段；c 纸张或其它媒体的规格；d 装订要求；e 分发对象；f 复制份数。456 恢复流程提示：
8、说明子程序 1 出现运行故障后的恢复方法和步骤。46 子程序 2 运行说明提示：用与本手册 4.5 节相似的方式介绍子程序 2 运行的有关信息。. . . . . .5非常规操作说明提示：给出有关应急操作或非常规操作的相应信息，如：出错处理操作、向后备系统切换操作以及其它必须向操作人员和程序维护人员交代的事项和步骤。附录 A提示：列出本手册用到的专门术语的定义和外文缩写的原词组。如：词汇表控制面板用于更改硬件和软件设置的一组工具。HTML (Hypertext Markup Language)一种用于创建 Web 页的语言。必须使用 Web 浏览器软件才能查看 HTML 文档。请参阅“Web
9、页” 。附录 B提示：给出与本软件相关的背景资料、基础知识等。如：四川省税收管理办法等附录 C提示:列出有关的参考资料。列出这些文件资料的标题、文件编号、发表日期和出版单位，以及说明能够得到这些文件资料的来源。如：1) “Windows NT设备驱动程序设计指南 ”，机械工业出版社，1997/12，CIP-232352) “Visual C+ 6 开发使用手册 ”，机械工业出版社， 1999/2，CIP-405813) “TCP/IP进行网际互连” ，电子工业出版社，1998/4，ISBN 7-5063-4607- 5/TP.2188四川托普集团技术文档 详 细 设 计 说 明 书 4) “研华嵌入式 PC平台 Windows CE解决方案” ，1999/4附录 D提示：前面未介绍而应该介绍的内容可以用附录的形式来说明之。. . . . . .
