技术手册模板.doc

XXX局 XXXXXX系统 技术手册 （XXX版本） 日期 版本 说明 作者 2005-01-01 V1.0  目 录 1. 引言 1 1.1. 编写目的 1 1.2. 系统背景 1 1.3. 术语定义 1 1.4. 参考资料 1 1.5. 版权声明 1 2. 系统概述 1 2.1. 系统功能 1 2.2. 系统性能 2 2.2.1. 数据精度 2 2.2.2. 时间特性 2 2.2.3. 系统灵活性 2 2.2.4. 系统安全性 2 2.2.5. 其他性能 2 3. 运行环境 2 3.1. 硬件环境 2 3.2. 软件环境 2 3.3. 数据结构 3 4. 服务器部署 3 4.1. 服务器部署结构 3 4.2. 应用服务器部署 3 4.2.1. 部署环境 3 4.2.2. 安装与配置 3 4.2.3. 部署验证 3 4.3. Web服务器部署 4 4.3.1. 部署环境 4 4.3.2. 安装与配置 4 4.3.3. 部署验证 4 4.4. 数据库服务器部署 4 4.4.1. 部署环境 4 4.4.2. 安装与配置 4 4.4.3. 数据初始化 4 4.4.4. 部署验证 4 4.5. 其它部署 5 5. 客户端部署 5 6. 系统日常维护 5 6.1. 执行文件 5 6.2. 权限管理 5 6.3. 参数配置 5 6.4. 系统日志 5 6.5. 数据备份与恢复 5 6.6. 其它维护 6 7. 常见问题解答 6 8. 售后技术支持 6 引言编写目的用到的专门术语的定义和 系统功能 指明本软件系统的系统目标、各部分功能简介、功能的使用范围等。 系统性能 数据精度 列明对数据的精度要求，在输入数据、输出数据、数据传输等环节。 时间特性 定量地说明本软件的时间特性，可包括：在线响应时间、更新处理时间、数据传输时间、故障切换时间、计算处理时间、连接建立时间、查询数据时间、统计分析时间。 系统灵活性 说明本软件所具有的灵活性、适应性和升级性，如当用户需求发生变化时，第三方软件发生升级时，本软件的适应能力。 系统安全性 说明本软件在安全、保密方面的设计考虑及实际达到的能力。 其他性能 运行环境 硬件环境 列明为运行本软件所要求的服务器、客户端的硬件设备的最小配置及当前环境的运行配置。 软件环境 说明为运行本软件所需要的软件支持和要求，如： 操作系统 数据库管理系统 应用中间件 消息中间件 ETL软件 OLAP软件 编译器 通信软件 安全软件 文件管理软件 其他应用软件 数据结构 列明为支持本软件的运行所需要的用户数据库及数据库表结构。 服务器部署 服务器部署结构 用图描述各个服务器的部署结构、分布情况及相互关系。 应用服务器部署 部署环境 应用服务器的部署环境简要介绍。 安装与配置 应用服务器的安装与配置步骤。 部署验证 部署成功与否的必要验证手段与方法。 Web服务器部署 部署环境 Web服务器部署环境简要介绍。 安装与配置 Web服务器的安装与配置步骤。 部署验证 部署成功与否的必要验证手段与方法。 数据库服务器部署 部署环境 数据库服务器部署环境简要介绍。 安装与配置 数据库服务器的安装与配置步骤。 数据初始化 数据库服务器的数据移植、数据导入，以及数据初始化的操作步骤。 部署验证 部署成功与否的必要验证手段与方法。 其它部署 客户端部署 客户端部署环境简要介绍。描述有关客户端软件的安装、初始化、配置、升级、卸载的操作步骤。 系统日常维护 执行文件 目录 文件 版本 修改日期 说明 Web-inf\classes\UserAdmin UserInfo.class V1.0 2005.9.28 用户管理包用户信息类 Web-inf\classes\UserAdmin Config.properties V1.0 2005.9.27 系统参数配置文件 权限管理 介绍系统用户权限的管理功能和设置方法。 参数配置 介绍系统运行参数的作用及其配置方法。 系统日志 介绍如何查看应用系统和运行系统的日志，出现异常情况如何处理。 数据备份与恢复 介绍数据库备份与恢复的操作内容和操作步骤。 其它维护 常见问题解答 在这部分要以问答的形式对该软件的使用技巧、使用故障的判断和排除方法进行详细说明。其中有关本软件的运行故障，列出可能发生错误的前提条件，指明为了确保恢复和重启动的能力，用户必须遵循的处理过程。 售后技术支持 清楚、准确地写明售后技术支持方案，向用户说明哪些内容由公司负责技服，哪些内容由其他厂商提供技服，写明详细的联系电话、通讯地址、网站或电子邮箱等。 XXX系统技术手册 第1页 XXX系统需求分析说明书 XXX系统技术手册 第1页 第1页