从技术的角度审视项目计划

一个好的项目计划需要在合适的时候计划处理以下技术内容:


* 技术类文档的准备

编码规约
是否定义了完善的编码规约,是否在内部讲解了编码规约的内容。

文档注释规约
是否定义了详细的文件注释规约,文件头注释格式定义,属性,方法注释定义,修改,删除的注释方法,版本升级定义等。

常见代码问题汇总
是否将常见的问题收集成文档,并且在项目组内部宣讲。

技术调查文档
各项技术调查结果文档化,技术调查要深入,保证后期项目开发的可用性,不会有调查不彻底而需要重新调查的风险。

环境配置文档
各种开发环境的配置说明文档化,需要有详细的确认步骤以确定环境是否安装正确,完备。

代码检查工具使用说明
对于使用代码检查工具(CheckStyle, Findbugs,Metrics等)的项目,需要指定代码检查工具的配置说明,修改级别,以及常见的修改方法。

* 技术类培训准备

语言基础培训
对于项目组内成员需要进行基本语言的说明,要说明语言的特点和使用方法,以及面向对象等特性。

框架培训
对于项目采用的开源框架,或者公司内部的框架需要有一个简单的例子来做讲解。

第一份代码培训
在先行开发阶段的成果无,经过自己检查,确立规则之后需要想所有项目组成员宣讲,以保证代码结构的一致性。

* 表格模板

代码CR记录模板
代码内部Review或者公开Review的时候的问题记录模板,可以方便整理代码的问题,记录开发过程中所发生的问题。
代码Review的结果要全员确认,宣讲。

代码CheckList
常见问题以及修改方法的列表,需要让开发人员仔细阅读。

* 工具

统一安装目录
由于目录不一致导致的开发问题非常多,情大家协调统一软件的安装目录和源代码的保存目录。

统一工具版本
由于开发工具版本不一致导致的问题也非常多,项目一定要制定开发工具版本的列表,保证工具的一致性。

统一编码格式
统一编码规约,ISO8859-1,UTF-8,GB2312,GBK等一旦编码格式指定,需要在全组范围内严格遵守。

统一开发目录
统一项目的开发目录,提高开发效率,降低问题发生的几率。

* 技术构架

三层结构
三层构架是比较常见的构建:
Presentation BusinessLogic DatabaseAccess

Presentation又可以分为: View(例如Panel, JSP等)和Action(例如Command或者Struts 的Action等)
BusinessLogic又可以根据需要使用Facade模式,重用业务逻辑
DAO又可以分为接口和实现,便于在不同的数据访问方法(iBatis,Hibernate,JDBC等)之间切换。

异常结构和抛出
定义项目的异常类型和集成结构,以及异常抛出的时机和包含的内容,以及异常消息获取的方式。

日志处理
定义日志输出的时机,级别,内容格式,存放方式(文件,数据库,mail等)等

安全处理
用户权限的获得,检查等

通用字符,日期处理函数

通用的字符处理,和日期处理函数。
通用业务处理

通用的业务处理方法的抽象。
代码模板
关键地方的代码编写模板,例如数据访问和事务,网络访问,文件读取,多线程等情况的代码模板。

数据库访问通用方法
查询,插入,更新,删除,批处理,存储过程调用,等通用方法的定义。

数据库事务处理
定义数据库事务处理的相关模板,最好能使用框架透明化事务处理,例如EJB技术,AOP技术等

对象创建和关联(考虑采用Springframework)
考虑复杂对象关联使用Spring的容器。

画面错误显示方式
错误显示要一致,明确。

你可能感兴趣的:(spring,数据结构,框架,Hibernate,ibatis)