易百贷项目详细设计文档模板.docx
《易百贷项目详细设计文档模板.docx》由会员分享，可在线阅读，更多相关《易百贷项目详细设计文档模板.docx（10页珍藏版）》请在冰豆网上搜索。
易百贷项目详细设计文档模板
微融信息技术有限公司
XX版本详细设计
文档标识：
CY---SD-01
微融信息技术有限公司
二〇一二年<8>月
版本号说明与版本历史
版本号说明
本文档的内容可能由于项目的持续工作而发生更改。
每次更改，文档的发布日期和递进版本号都将明显的被更改。
版本号的递进遵循以下原则：
版本x.yy.zzz
z当文档中仅加入了纯粹编辑的更改时，第三位数字发生增长。
初始数字为0。
Y当其它类型的更改发生时，如技术改良、更正、更新等，第二位数字发生增长。
初始数字为0。
X当文档确定为一个阶段性文档时，第一位数字发生增长。
初始数字为1。
版本历史
日期
版本
修改内容说明
评审号
变更控制号
作者
2012-8-20
V0.0.1
新建
目录
1.前言5
1.1.文档目的5
1.2.使用范围5
1.3.名词解释5
1.4.参考资料5
2.系统设计6
2.1.总体描述6
2.2.总体流程6
2.3.工单日志查询导出6
2.3.1.功能描述6
2.3.2.功能界面7
2.3.3.功能菜单7
2.3.4.数据描述7
2.3.5.处理流程7
3.数据库设计8
3.1.XXX表8
本文件中出现的任何文字叙述、文档格式、插图、照片、方法、过程等内容，除另有特别注明，版权均属广州市诚毅科技软件开发有限公司所有，受到有关产权及版权法保护。
任何个人、机构未经广州市诚毅科技软件开发有限公司的书面授权许可，不得复制或引用本文件的任何片断，无论通过电子形式或非电子形式。
1.前言
1.1.文档目的
本设计文档主要描述XXX版本开发计划的实现方式。
本设计文档的目的是改善项目的版本质量，使问题在需求分析阶段尽可能额暴漏，减少编码阶段和测试阶段的盲目性，保障版本的上载后的稳定性。
本设计文档的目标是假设项目组开发人员不熟悉版本计划和BOSS系统业务的前提，按照本详细设计的要求可以顺利完成分配的开发任务，降低开发人员实现需求因考虑不周全，给版本带来系统性风险。
适用于开发人员和测试人员使用，也可作为需求评审的来源。
1.2.使用范围
本设计文档仅适用于版本xxx版本开发计划，是项目版本维护中的阶段性产出。
1.3.名词解释
术语/缩略词
解释
BOSS
BusinessOperationSupportSystem
1.4.参考资料
资料名称
作者
XX项目-XX版本管理计划
2.系统设计
2.1.总体描述
XX版本管理计划包括若干需求、优化和缺陷，统称为待实现的功能点。
按照每个功能点一小节描述。
其中需求和缺陷描述会相对描述详尽。
方便阅读的前提下，小节标题尽可能的简化，标题下面对应XXX版本管理版本内容的条目。
功能描述是介绍功能点实现的原理，使用的需求的知识、参考的文档等；功能界面采用viso或者图片直观展示，尽可能的通俗易懂，并配有文字介绍；功能菜单用于新增功能，业务控制点配置的位置和名称；数据描述会严格规定相关的库表写哪些值才有效，保证数据的严密性；处理流程包括前台jsp、JS流程和后台Logic业务流程，设计文档编写规则参考2.2节。
2.2.设计要求
2.2.1.新增查询
查询功能需列出查询页面的查询条件，查询表头，查询结果和查询关联和数据导出。
查询条件需列出使用哪些表的字段做为查询条件，使用参数则需列出具体的参数名称；查询条件需指出输入还是选择，输入则需验证输入是否合法，验证长度约束。
条件字段为日期时需使用日期选择输入。
涉及业务区和业务类型的还需指出权限变化，查询条件是否与业务类型和业务区关联变化。
查询表头需具体列出查询表头，同时指出是否可排序。
查询结果与表头一一对应，参数的需翻译。
查询关联需列出查询关联的表和条件。
如使用自定义的语句查询，需列出详细的查询语句。
数据导出需列出使用那种类型导出方式，大数据量导出和前台导出，调用公用导出即可。
2.2.2.优化查询
优化查询需列出优化部分的前后逻辑对比变更部分，变更查询的那一部分功能，需明确指出。
如新增查询条件，需列出使用哪些表的字段，是否影响表关联；删除查询条件是否会影响查询关联；假如是优化查询的内部逻辑，需详细列出判断条件的变更情况，防止遗漏。
2.2.3.新增业务
新增业务功能需列出前台页面，数据表设计，业务规则，入账逻辑。
前台页面需列出页面的布局，页面字段对应数据表的字段，若无对应则说明字段的用途；字段的约束性特征，包括字段是用于文本输入还是选择输入，文本输入是否有长度和类型的验证；选择输入是否用参数，若有参数需指明具体的参数名称。
前台页面需指明业务使用的操作代码，费用和部分特殊字段是否有权限限制。
数据表设计是指新增业务是否需要新增数据表或者变更数据表，若需要则在数据库设计说明，并指出是新增表还是变更表，新增和变更表需考虑轨迹表的新增和变更。
业务规则是指针对实现的业务所需的业务规则约束。
需详细列出业务的业务规则特征，针对每一条业务规则，在前台页面实现的位置或者入账逻辑实现。
入账逻辑是业务的数据提交部分，按照数据验证，创建业务流水号，写业务相关表，写业务异动表，费用明细表，发送授权的过来才写数据。
2.2.4.优化业务
优化业务需列出优化的功能点位置：
前台页面，数据表设计，业务规则和入账逻辑。
不论优化哪个位置都需列出优化功能的前后特征对比，只有彻底理解优化前的处理方式，可能按照要求完成优化的功能。
优化前台页面，若优化的前台页面为公用页面，则需查找列出所有使用公用页面的业务，并验证是否对其他业务有影响。
优化数据库设计，包括新增表字段，删除表字段和表字段使用调整，不论那种方式需考虑是否写有轨迹表，若写有轨迹表则轨迹表字段需同步调整，以下分类描述不再单独介绍轨迹表。
新增表字段，需考虑字段的类型，是否使用参数实现，是否必填，写入数据后数据如何维护，在哪个位置展现给用户，同时提醒后台程序报表是否发送变更。
删除字段的同时需考虑页面是否绑定该字段，若绑定则需同步删除，若数据表有数据则需割接清理，且检查其他业务和查询是否展现该字段，删除字段慎用已上线功能，若弃用可保留字段清空值，隐藏其他业务该字段，将来用于其他用途使用。
表字段是文本类型加长，则只需修改库表字段，若是数字类型精度发送变更，则需数据割接，提前写好割接方案，测试机割接成功后，安排好时间在生产系统实施。
优化业务规则，需穷举原业务规则和新业务规则，以及前台导致的相关业务变更。
若实施难度大需外部条件支撑、或新规则与其他规则冲突，需及时提出跟客户沟通后调整。
穷举业务规则后，找出相关的业务，按照业务规则开发代码实现。
入账逻辑优化一般是性能的调整，或者规范性要求。
如入账处理速度慢，需找出入账慢的语句执行处分析原因优化；规范性要求是指写业务数据的前后顺序不可按照个人意愿写数据，要按照文档规范的顺序写。
2.2.5.新增管理模块
管理模块包括四部分：
新建、修改、删除和查询。
其中查询参见2.2.1新增查询部分。
新建功能包括前台页面和数据表设计。
前台页面和数据表设计可参考2.2.3节的新增业务的前台页面和数据表设计描述。
修改功能是对新建的功能数据进行维护，维护数据时需确认可维护的数据和保持不变的数据，保持不变的数据页面不展示或者置灰只读，不可编辑。
表数据发送变更后，需检查是否有依赖此表的数据需同步。
删除功能是指删除当前数据表的行数据。
删除前需确认删除此行数据的规则，是任意可删除还是需哪种条件删除，如当前表主键为其它表外键，则不允许直接删除。
2.2.6.优化管理模块
优化管理模块包括优化新建，修改，删除，查询。
不论优化哪一部分，都需列出前后的变更部分。
查询部分可参考优化查询业务2.2.2节。
优化新建和修改可参考2.2.4优化业务的前台页面和优化数据表设计小节。
优化删除是指优化删除的条件，新增或减少删除约束条件。
只需按照规则实现代码即可。
2.3.XXXX功能
XX项目-版本管理计划.xls文档，版本内容第30条：
2.3.1.功能描述
（描述针对指定的需求，业务上要实现一个什么样的功能，达到一个什么样的效果）
2.3.2.功能界面
（对于新增功能，如果没有界面的话，可不做界面图，对于修改的功能点，则将系统界面截图并加以说明）
2.3.3.功能菜单
（指出功能所在的菜单，即设置的业务控制点路径）
2.3.4.数据描述
（如果在前台有功能菜单的话，需将展现的各个数据项进行解释说明，说明各个展现项的数据取自哪个库表，以什么样的规则得到的；对于信控、接口类型的程序，需将数据处理的规则进行说明）
2.3.5.处理流程
（说明后台程序的处理流程，说明程序执行过程中，以什么样的条件，扫描了哪几个库表，对数据做了什么样的处理，处理了哪几个表的数据，程序执行到最后，数据达到一个什么样的结果）
3.数据库设计
3.1.XXXX表
序号
名称
标识符
数据类型/值长
关键字及其他
1.
索引:
unique
4.例子
4.1.宽带发展统计日报表/月报表修改
陕西项目-V1.8.5版本管理计划.xls文档，版本内容第38、42条
4.1.1.功能描述
宽带发展统计日报表：
统计每天宽带业务发展数据
宽带发展统计月报表：
统计上月宽带业务发展数据
4.1.2.功能界面
暂无
4.1.3.功能菜单
功能点位置：
报表查询-业务发展-数据业务-宽带发展统计日报表
功能点位置：
报表查询-业务发展-数据业务-宽带发展统计月报表
4.1.4.数据描述
宽带发展统计日报表
新增用户
终端数：
当天新开通/增开通-当天所有新开通/增开通的回退（除老系统续费用户开户）
缴费月：
当天新开通/增开通-当天所有新开通/增开通的回退（除老系统续费用户开户）
金额：
当天新开通/增开通-当天所有新开通/增开通的回退（除老系统续费用户开户）
新系统续费
终端数：
当天新系统用户续费-回退当天所有新系统用户续费
缴费月：
当天新系统用户续费-回退当天所有新系统用户续费
金额：
当天新系统用户续费-回退当天所有新系统用户续费
旧系统续费
终端数：
当天老系统用户续费-当天所有老系统用户续费的回退
缴费月：
当天老系统用户续费-当天所有老系统用户续费的回退
金额：
当天老系统用户续费-当天所有老系统用户续费的回退
销户
终端数：
当月所有销户的用户数-当天所有销户的回退
缴费月：
所有销户的缴费月-当天所有销户的回退缴费月
金额：
所有销户的金额--当天所有销户的回退金额
续费终端数合计：
新系统续费终端数+旧系统续费终端数
续费用户缴费月合计：
新系统续费缴费月+旧系统续费缴费月
续费用户金额合计：
新系统续费金额+旧系统续费金额
宽带发展统计月报表
新增
本月新增：
当月新开通/增开通-当月所有新开通/增开通的回退（除老系统续费用户开户）
缴费月：
当月新开通/增开通-当月所有新开通/增开通的回退（除老系统续费用户开户）
金额：
当月新开通/增开通-当月所有新开通/增开通的回退（除老系统续费用户开户）
新系统续费
本月应续费：
月初时统计的本月宽带到期终端数
当期续费：
当月到期续费-当月到期续费回退
过期续费：
当月过期续费-当月过期续费回退
提前续费：
当月提前续费-当月提前续费回退
本月共续费：
当期续费+
升级会员 