安装部署说明书-模板.doc

武汉瑞得软件产业有限公司 文档模板 武汉瑞得软件产业有限公司 地址：武汉市洪山区雄楚大道229-1号智源财富中心A区2705 邮政编码：430074 电话：027 传真：027233 公司网址： PAGE 2 XXX项目 安装部署说明书 武汉瑞得软件产业有限公司 Wuhan READ Software Industry Co., Ltd. 拟制：乐强 文档编号：WHREAD_TEMP_安装部署说明书 审核：胡良超 批准：李鹏 版本号： V3.0 生效日期：2010年12月23日 机密等级：内部公开 修改记录 修订号 作者 日期 简要说明 V0.1 乐强 2010 新制作 V0.2 乐强 2010年2月3日 评审版 V1.0 乐强 2010年2月10日 正式发布 V2.0 乐强 2010年4月5日 正式发布 V3.0 乐强 2010年12月23日 正式发布  TOC \o 1-4 \h \z 1 引言 1 1.1 编写目的 1 1.2 背景 1 1.3 定义 1 1.4 参考资料 1 2 系统配置 1 2.1 运行环境 1 2.2 系统安装部署图 2 2.3 系统硬件配置 2 2.4 系统应用服务器软件安装与配置 2 3 程序部署 2 3.1 应用程序部署 2 3.1.1 参数配置 3 3.1.2 编译 3 3.1.3 打包 3 3.2 服务器参数设置 3 4 运行和停止 3  引言 编写目的 说明编写这份说明书的目的，指出预期的读者。如果SIT\UAT\Production环境的安装部署过程不一样，需要分别说明。 注：使用模版时，斜体字请自行删除。 背景 说明： 待开发软件系统的名称； 本项目的任务提出者、开发者、用户 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 参考资料 列出有关的参考文件 系统配置 运行环境 描述开发环境应客户一致情况，我们需要遵循以下要求： 如： 操作系统使用英文版Windows2000Professional，区域设置选择中国大陆，语言选择简体中文（标明操作系统的版本号） 数据库使用MySQL，数据库系统使用UTF8字符集。 使用CVS作为代码管理工具 使用Ant做为编译部署工具 使用与客户相同的项目目录结构 系统安装部署图 描述目标系统与其他系统/数据源关系图，在部署图下面需加列表注释，写上相关配置文件所在、具体标签和值，其中“值”用红色斜体字标注。 系统硬件配置 列出系统需要的硬件配置，并说明安装步骤。 系统应用服务器软件安装与配置 列出系统需要的软件名称和版本，获取该软件的方法，并分别进行说明配置步骤。 如：J2SDK 1.4 J2SDK1.4.1的安装 从 上下载J2SDK1.4.1安装包，直接用安装包安装即可，这里记录安装目录％JAVA_HOME％ APACHE ANT 的安装 从 /下载apache ant最新版本，直接解压缩至硬盘，这里记录该目录为?%ANT% Tomcat的安装 直接用安装包运行安装即可，这里记录Tomcat安装目录为?%TOMCAT_HOME% 安装完毕后，需设置一些系统环境变量： Set JAVA_HOME=%JAVA_HOME% Set ANT_HOME=%ANT% 数据库软件的安装和配置 数据库创建 运行相应的脚本文件,如：创建数据库表、插入原始数据 程序部署 说明源码管理工具和获取方法，如：使用CVS进行源码管理，在项目根目录使用checkout module命令，输入路径获得项目的最新源码。 应用程序部署 如：说明参数配置，编译打包，如果SIT/UAT/production环境不同，需分别说明 PS:配置文件里面，正确的参数用黑体字（例如系统参数在UAT和Production的环境中不用改），需要修改的参数用红色斜体字标注（不同环境不同值）。 PS:安装folder（根据HKIT习惯,例如用tomcat用户名部署tomcat相关内容：/home/tomcat/tomcat）用红色斜体标注 PS:具体环境的配置由部署的人在相应的SERVER上更改 参数配置 编译 编译过程不需要分(SIT/UAT/production)不同的命令进行编译 打包 服务器参数设置 运行和停止