项目开发规范文档

1、文档编号：T/KFGGF文档版本：0.1项目编号：YC_FLLATFFORMM项目开发规范文档编写人：徐文兵日期：2009-7-20审核人：日期：批准人：日期：修改记录（RREVIISIOON CCHARRT）0.1徐文兵初稿2009-7-2221概述目的与概述述本文档为XXX公司司的开发发规范文文档，给给开发团团队提供供开发标标准和规规范。整体说明 在在开发规规范中包包含了两两个部分分，第一一部分是是项目开发发流程规规范，主主要阐述述在项目目开发过过程中的的各个阶阶段的规规范。第第二部分分为Coodinng开发发规范，Coddingg开发规规范阐述述了在一一个框架架中的各各个层的的开发规规范

2、（注：在第第一版中中不包含含对工作作流开发发的规范范制定）覆盖范围阅读对象项目管理人人员系统设计人人员系统开发人人员参考资料略2 项目开开发流程程规范2.1 业业务需求求调研阶阶段调研的目标标 系统统层面： 客户户的系统统运行环环境业务层面：了解客户户需要什什么样的的系统，具体了了解业务务目的，业业务逻辑辑，业务务数据，客户的操作习惯，页面风格习惯等。调研的准备备工作：行业知识的的准备：了解客户的的行业背背景，行行业领域域的业务务术语，含含义。结结合客户户行业背背景，了了解客户户的业务务知识。业务专家需需求：在行业领域域的复杂杂度不高高的情况况下，业业务分析析人员直直接收集集并学习习行业知知识

3、就可可以了，但但行业知知识的准准备工作作还是要要做的在行业领域域业务复复杂度高高的情况况下，需需要业务务专家对对客户的的业务的的进行整整理。调研的流程程：第一步 ，项项目启动动阶段 了解客客户的IIT环境境。第二步， 讨论并并具体确确定客户户系统的的范围，并获得客户业务功能点的原始的单据。在这个过程中准备一个本和一只笔记录讨论的业务信息第三步， 整理业业务信息息，和原原始表单单，抽取取出有效效业务信信息，并并对于不不明确的的业务信信息进行行整理和和归类，并并制作成成问卷形形式进一一步调研研。第四步， 发放调调研问卷卷，再次次进行业业务调研研（直接接转到三三）第五步，卷卷写调研研问卷，并并内部评

4、评审第六步，调调研问卷卷客户评评审并确确认。调研阶段的的交付项项（可配配置项）软件需求说说明书软件需求说说明书的的目录：1 客户行行业背景景2 客户系系统的意意义3 客户系系统运行行的环境境4 业务功功能点描描述（业业务目的的，业务务逻辑，业业务数据据，优先先级别，使使用频率率等） 55 客户户的操作作习惯，页页面风格格习惯。2.2 概概要设计计阶段概要设计阶阶段主要要分两个个步骤： 1 框架架设计 22业务模块块概要设计计 ,下下面分别别对两个个步骤进进行描述述：2.2.11框架设设计（注：这这边的框框架设计计是按照照传统的的开发方方式进行行阐述，基基于平台台的开发发方式待待补）框架设计的的

5、目标：根据客户需需求，设设计系统统的后台台架构，前前台界面面框架，数数据模型型。在设设计之前前要考虑虑客户的的业务特特点，性性能要求求，已有有的ITT环境，同同时还要要考虑将将来业务务的增长长，保证证系统一一定得可可扩展性性。框架设计包包含的内内容：后台框架：各层的的职能划划分，技技术实现现的方式式，层之之间的交交互规则则，异常常处理规规则，目目录定义义规则界面框架：操作主主界面定定义 页面整整体风格格的定义义，页面面流转关关系等 数据据模型： 系统统基础数数据（组组织人员员结构，权权限设置置，字典典参数设设置） 业务数数据框架设计阶阶段交付付项：文档 ：系系统架构构 界面框框架 数据模模型注

6、：三份文文档可以以融合在在一份文文档之中中。2.2.22业务模模块概要要设计系统设计人人员根据据业务分分析人员员的业务务需求文文档，进进行概要要设计。在在概要设设计过程程中主要要关注三三个关键键点1） 业务务模块的的页面显显示内容容：信息息显示的的内容，显显示的方方式；交交互接口口的定义义，等 举例例：查询询人员信信息模块块操作说明，查查询条件件，显示示字段，排排序和显显示方式式。2）业务逻逻辑描述述对业务逻辑辑进行详详细的描描述。3）业务数数据项 业务务模块涉涉及到数数据的描描述。具体的描述述包含数据项名称称 ，显示方方式，是否必必填，输入方方式，相关逻逻辑概要设计阶阶段的交交付项概要设计文

7、文档2.3业务务需求理理解阶段段2.3.11系统设设计人员员理解需需求在系统设计计人员理理解需求求之前，业业务分析析人员必必须提供供相关模模块的客客户需求求文档。 系统设设计人员员阅读并并理解客客户需求求文档。理解需求文文档的交交付结果果（可配配置项）业务需求对对于客户户来讲，目目的是什什么，解解决什么么问题，有有什么意意义？具体业务的的执行逻逻辑是什么？在业务流转转过程中中的业务务数据有有哪些？需求理解时时间要求求：简单的需求求，理解解时间为为2-33 小时时复杂需求：理解需需求时间间4-88小时复杂的业务务需求需需要需求求分析人人员确认认。复杂的业务务需求按按照涉及及到的业业务的复复杂度来

8、来决定的的。2.4详细细设计阶阶段详细设计阶阶段分两两个步骤骤第一步骤，系系统设计计人员根根据业务务需求的的理解,详细设设计业务务模块，并并出详细细设计文文档第二步骤，核核心设计计人员对对系统设设计人员员的详细细设计文文档进行行技术评评审。2.4.11系统设设计人员员详细设设计阶段段系统设计人人员根据据业务需需求，详详细设计计模块。详细设计阶阶段的交交付结果果（可配配置项）详细设计文文档：业务接口定定义数据库的数数据项定定义Web页面面和Jss接口定定义等注：对于复复杂的模模块可以以在详细细设计文文档中可可以包含含了UMML类图图，和时时序图 ，从而而进一步步描述设计计的内容容详细设计时时间要

9、求求：简单的业务务需求：2-44小时复杂的业务务需求44-122小时详细设计文文档的书书写原则则：系统设计人人员在文文档中能能描述清清楚业务务模块的的详细设设计，不不拘泥于于格式。2.4.22 技术术评审阶阶段技术评审流流程：1）系统统设计人人员在技技术评审审之前，将将自己的的详细设设计文档档分发给给技术评评审的与与会人员员。2）在技术术评审过过程中，系系统设计计人员首首先讲述述详细设设计文档档3）评审人人员对详详细设计计中各个个环节进进行询问问和确认认，提出出修改方方案。4）最后项项目技术术负责人人确认调调整后的的设计方方案。技术阶段的的交付结结果（可可配置项项）业务确定的的详细设设计文档档

10、。注：此文档档是交付付确认的的标准之之一。2.5Coodinng阶段段系统开发人人员根据据业务的的项目详详细设计计文档，进进行实际际Coddingg过程。在Codiing过过程中的的注意事事项1） 在CCodiing过过程中严严格按照照Coddingg开发规规范来执执行。2）在Coodinng过程程中，发发现详细细设计文文档中的的严重缺缺陷，则则需要和和项目设设计人员员确认，如如非常复复杂，则则需重新新技术评评审。3）在详细细设计发发生改变变时，需需要及时时更新详详细设计计文档。2.6业务务模块确确认交付付阶段项目技术负负责人和和业务分分析人员员共同对对业务模模块进行行验收。验收步骤：1）业务

11、分分析人员员确认功功能模块块实现功功能和客客户需求求一致2）技术负负责人对对功能模模块进行行技术上上的确认认。3）测试人人员的测测试报告告注：第三步步主要看看公司的的具体的的情况和和业务复复杂度， 第第三步完完成流程程如下：1）准备测测试阶段段 测测试人员员根据业业务需求求，设定定一个业业务环境境，写成成测试脚脚本， 2）测测试阶段段 根据测测试环境境和业务务需求 进行测测试 3）根据测试的结果，出测试报告。2.7 系系统集成成测试根据客户业业务需求求，测试试人员设设定一个个测试环环境，编编写测试试脚本，在在测试服服务器上上部署好好系统。按按照测试试用例进进行业务务功能上上测试。测试人员准准备工作作清单：测试用例测试脚本当前实现模模块硬件