密 级:(小四,宋体,加粗,居右;机密)
<项目名称>
项目开发规范及环境说明
编制: 日期:
审核: 日期:
批准: 日期:
版本:V1.0.0
控制状态:
(宋体,四号,加粗,居中)
华迪计算机有限公司
修订记录(二号,宋体,加粗)
第N次变更 | 版本号 | 修订简要(章节、原因) | 修订人 /日期 | 批准人 /日期 |
1.概述
1.1.概述
概要描述整个项目的基本情况
2.项目目录结构
2.1.目录结构
以表格的形式罗列项目中涉及的目录及含义。(建议目录采用英文小写,这样不会因为在weblogic下可以不分大小写,oc4j却对大小写敏感;避免在移植时产生麻烦)
例如:
2.2.程序调用结构
3.项目运行环境
3.1.应用服务器
指明开发和发布将采用的应用服务器及其版本,并描述项目适应的应用服务器(如oc4j,tomcat,weblogic等等)及本项目中不同应用服务器的优化参数。
3.2.服务器的配置及操作系统
指明运行系统的应用服务器、数据库最低主机的配置和操作系统。(如CPU、内存、是否需要做cluster等)
3.3.数据库
指明采用的什么数据库,数据库的版本;数据库需要进行什么优化。
3.4.JDK版本
指明采用的JDK的版本
3.5.客户端主机配置
指明运行应用程序客户端最低的配置(硬件和软件),是否需要安装其他软件。
3.6.华迪架构包
指明采用的华迪架构包的版本
3.7.权限包
3.8.日志
3.9.采用的其他公共组件
如果项目采用了诸如图像采集,打印控件、列表控件、公共类等,用表格的形式对这些控件的版本、出处、及在项目中的具体用法等加以说明。
4.项目其他规范说明
4.1.业务增删改操作的处理
用图或者文字描述该项目中对于涉及增、删、改等业务操作采用的处理方式,并举例说明。
如果有几种处理方式则分别说明
4.2.事务的处理
用图或者文字描述该项目中对于事务控制方面的处理。
4.3.查询操作的处理
用图或者文字描述该项目中对于查询等业务操作采用的处理方式,并举例说明。
如果有几种处理方式则分别说明
4.4.统计报表的处理
用图或者文字描述该项目中对于统计报表方面的处理
4.5.打印的处理
用图或者文字描述该项目中对于打印(全打、套打)的处理
4.6.错误的处理
用图或者文字描述该项目中对于几种不同类别错误的处理方式。
4.7.日志方面的处理
用图或者文字描述该项目中对于几种不同类别日志的处理方式。
4.8.权限控制方面的处理
用图或者文字描述该项目中对于业务权限控制的处理方式。
4.9.单点登录方面的处理
项目中如果涉及单点登录,则描述项目在该方面的处理方式。
4.10.图形展现方面的展示
描述项目中处理图形展示方面采用的技术和方法。
4.11.可配置性方面的处理
描述该项目中在柔性化、可配置性方面的考虑和处理方式。
。。。。。
。。。。