软件使用说明范例

文文 档档 编编 号号产品版本产品版本密级密级 XK DN 2000 10 11 16 V 1 0内部 请在这里输入公司名称 产品名称 产品名称 共共 页页 仅供内部使用仅供内部使用 文文 档档 作作 者 者 日期 日期 说说 明明 书书 校校 对 对 日期 日期 产产 品品 经经 理 理 日期 日期 请在这里输入公司名称请在这里输入公司名称 版权所有版权所有 不得复制不得复制 Comment jwy1 Page 2 编写本使用说明的目的是充分叙述本 软件所能实现的功能及其运行环境 以 便使用者了解本软件的使用范围和使用 方法 并为软件的维护和更新提供必要 的信息 Comment jwy2 Page 2 说明本软件的用途 包括 a 本软件开发目的 b 基本原理 c 基本功能 Comment jwy3 Page 2 用图表加部分文字叙述的方法描述本 软件运行时系统输入源和系统输出机构 之间的关系以及运行过程 Comment jwy4 Page 2 概述本软件的所使用的硬设备 包括 计算机和外部设备等 的类型 数量以 及配置管理说明 配置的标志 控制和 状态记录等 Comment jwy5 Page 2 概述本软件的总体结构 逻辑组成 如分程序和模块 并阐述在系统运 行中的作用 Comment jwy6 Page 2 简要叙述软件的全部性能 包括 a 输入信息类型 格式 量 速率和 响应时间 b 输出信息类型 格式 量 速率和 响应时间 c 处理时间 d 处理出错能力 包括检测各种错误 能力和纠正错误的方法 e 灵活性和可靠性 如允许系统扩充 的能力 备用处理和切换能力等 Comment jwy7 Page 2 对每项输入均需说明 a 输入名称 b 输入目的 c 输入方法 d 输入源 e 输入量范围或参考数据 Comment jwy8 Page 2 介绍输入的数据如何被处理 最后产 生的输出与输入量和其它量的关系 Comment jwy9 Page 2 对每项输入均需说明 a 输出名称 b 输出目的 c 输出内容 d 接收者 e 输出量范围 软件使用说明 XK DN 2000 10 11 16 仅供内部使用 2 1 引言引言 1 1 编写目的 编写本使用说明的目的是充分叙述本软件所能实现的功能及其运行环境 以便使用者了解本软 件的使用范围和使用方法 并为软件的维护和更新提供必要的信息 1 2 参考资料 略 1 3 术语和缩写词 略 2 软件概述软件概述 2 1 软件用途 本软件的开发是为具有电能质量仪表 可以获取电能数据的技术人员提供一个有利的分析工具 2 2 软件运行 本软件运行在 PC 及其兼容机上 使用 WINDOWS 操作系统 在软件安装后 直接点击相应 图标 就可以显示出软件的主菜单 进行需要的软件操作 2 3 系统配置 本软件要求在 PC 及其兼容机上运行 要求奔腾 II 以上 CPU 64 兆以上内存 10G 以上硬盘 软件需要有 WINDOWS 98 操作系统环境 2 4 软件结构 略 2 5 软件性能 略 2 6 输入 处理 输出 2 6 1 输入 略 2 6 2 处理 略 2 6 3 输出 分析数据为 略 图表有 略 Comment jwy10 Page 3 介绍本软件安装步骤和系统初始化方 法 Comment jwy11 Page 3 用表格的形式给出由软件组成的各种 运行 亦即作业 简要说明每个运行 的目的 指出每个运行所执行的程序 Comment jwy12 Page 3 说明从一个运行转到另一个运行 直 至完成整个运行周期的步骤 Comment jwy13 Page 3 以操作人员使用上最方便的形式 说 明运行 1 的有关信息 Comment jwy14 Page 3 列出该运行的运行流控制语句或控制 命令 Comment jwy15 Page 3 给出管理该运行成年需要的信息 包 括 运行标识符 需要的外设资源 安 全保密 启动方法 如请求随机启动和 按预定时间启动 预计的运行时间和解 题时间 操作命令 抽取检验点的过程 该运行中所碰到的问题 Comment jwy16 Page 3 给出由该运行建立 更新或访问的文 件的有关信息 如 文件名或标号 安 全保密 记录媒体 文件的处置 Comment jwy17 Page 3 说明该运行产生的输出报告 如 报 告的标识 安全保密 存储媒体 即硬 拷贝 磁带 报告的规模 拷贝份数 分发对象 Comment jwy18 Page 3 说明输出报告的复制 如 报告的标 识 复制技术 安全保密 纸张或其它 媒体的规格 装订方式 复制份数 分 发对象 Comment jwy19 Page 3 说明该软件失效时的再启动和恢复过 程 Comment jwy20 Page 3 列出本软件运行中可能产生的各种出 错编码表和使用者应采取的纠错措施 并指出为确保每次启动和恢复成功 使 用者应遵循的处理步骤和注意事项 Comment jwy21 Page 3 给出应急或非常规操作的必要信息 如 a 向后备系统的切换 b 向维护程序员移交的步骤 Comment jwy22 Page 3 列出本软件系统设计中使用的全部规 则和约定 包括 a 程序 分程序 模块 数据区 工 作单元区的标识的使用规则 b 图表的处理和标准化 出现在图表 中的符号名 有关语句和记号中使用的 缩写等 c 使用的软件标准 软件使用说明 XK DN 2000 10 11 16 仅供内部使用 3 3 软件使用过程软件使用过程 3 1 软件安装 直接点击软件的安装软件 SETUP EXE 然后按照软件的提示进行 3 2 运行表 略 3 3 运行步骤 略 3 4 运行说明 略 3 4 1 控制输入 按照软件的说明 将测试数据加入到软件中 具体过程如下 略 3 4 2 管理信息 软件运行过程中的密码键入 略 3 4 3 输入输出文件 略 3 4 4 输出报告 略 3 4 5 输出报告复制 略 3 4 6 再启动及恢复过程 略 3 5 出错处理 软件运行过程中可能雏形的出物及处理如下 略 3 6 非常规过程 如果出现不可能处理的问题 可以直接与公司的技术支持人员联系 略 4 软件维护过程软件维护过程 4 1 程序设计的约定 本软件程序是一个单一的运行软件 各个软件子模块的预定如下 略 Comment jwy23 Page 4 列出出错状态及其错误来源和纠正过 程 Comment jwy24 Page 4 列出用于本软件系统维护的专用程序 目录 如文件恢复程序 淘汰过时文件 的程序等等 并加以说明 内容包括 a 维护作业的输入输出要求 b 输入维护程序的过程 c 在硬设备上建立 运行并完成维护 作业的操作步骤 Comment jwy25 Page 4 在必要时以附录方式列出本系统程序 清单 Comment jwy26 Page 4 以引用参考资料形式说明本系统程序 详细流程图 软件使用说明 XK DN 2000 10 11 16 仅供内部使用 4 4 2 出错及纠正方法 可能由于输入的数据不符合软件的要求 软件将可能提出错误 并提醒您按照软件的要求运行 程序 可能出现的问题见下表 略 4