Skip to content

重构&设计建议 的提交模板

HuQingfang edited this page May 13, 2017 · 3 revisions

对 Rafy 框架有重构想法的同学,特别是期望有比较大的重构的情况下,请尽量编写以下设计思路和方案,方便大家沟通。 一旦确定后,即可按照此重构方案实施。

一、 任务说明书

[任务说明书是重构能否达成的关键指标,应该详细的列出为什么要重构,本次重构的目标]

1、 原设计方案

[本节应给出原方案的关键类图、序列图等。]

2、 原方案的优点

[剖析原设计方案,原设计方案的好处]

3、 问题描述

[问题描述应该详细列出重构的原因,什么原因导致了此次重构:如性能问题、安全问题、扩展性问题、Bug问题、用户体验问题等等]

4、 任务目标

[此次重构应该满足的目标,目标是衡量重构是否可以结束的关键指标]

二、 方案选型

[简单列出所选方案的优缺点,使用场景等,对各个方案的优缺点进行比较,从而得到最后的方案]

[方案1]

[方案2]

[方案n]

三、 选定设计方案

[本节应给出方案的关键类图、序列图等,对原有系统的影响,升级方案等]

1、 系统设计

[本节应给出原方案的关键类图、序列图等。]

2、 对原系统影响

[列出对原有系统的影响范围,方便开发人员对相关模块进行修改,如没有则写无]

3、 升级方案

[应提供详细的升级方案,方便系统进行升级]

Clone this wiki locally