项目开发规范文档

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

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

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

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

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

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

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

8、求需要需需求分析析人员确确认。复杂的业业务需求求按照涉涉及到的的业务的的复杂度度来决定定的。2.4详详细设计计阶段详细设计计阶段分分两个步步骤第一步骤骤，系统统设计人人员根据据业务需需求的理理解,详详细设计计业务模模块，并并出详细细设计文文档第二步骤骤，核心心设计人人员对系系统设计计人员的的详细设设计文档档进行技技术评审审。2.4.1系统统设计人人员详细细设计阶阶段系统设计计人员根根据业务务需求，详细设设计模块块。详细设计计阶段的的交付结结果（可可配置项项）详细设计计文档：业务接口口定义数据库的的数据项项定义Web页页面和JJs接口口定义等等注：对于于复杂的的模块可可以在详详细设计计文档中中可

9、以包包含了UUML类类图，和和时序图图 ，从从而进一一步描述述设计的的内容详细设计计时间要要求：简单的业业务需求求：2-4小时时复杂的业业务需求求4-112小时时详细设计计文档的的书写原原则：系统设计计人员在在文档中中能描述述清楚业业务模块块的详细细设计，不拘泥泥于格式式。2.4.2 技技术评审审阶段技术评审审流程：1）系系统设计计人员在在技术评评审之前前，将自自己的详详细设计计文档分分发给技技术评审审的与会会人员。2）在技技术评审审过程中中，系统统设计人人员首先先讲述详详细设计计文档3）评审审人员对对详细设设计中各各个环节节进行询询问和确确认，提提出修改改方案。4）最后后项目技技术负责责人确

10、认认调整后后的设计计方案。技术阶段段的交付付结果（可配置置项）业务确定定的详细细设计文文档。注：此文文档是交交付确认认的标准准之一。2.5CCodiing阶阶段系统开发发人员根根据业务务的项目目详细设设计文档档，进行行实际CCodiing过过程。在Coddingg过程中中的注意意事项1） 在在Coddingg过程中中严格按按照Coodinng开发发规范来来执行。2）在CCodiing过过程中，发现详详细设计计文档中中的严重重缺陷，则需要要和项目目设计人人员确认认，如非非常复杂杂，则需需重新技技术评审审。3）在详详细设计计发生改改变时，需要及及时更新新详细设设计文档档。2.6业业务模块块确认交付

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