详细设计文档质检标准文档格式.docx

详细设计文档质检标准文档格式.docx

《详细设计文档质检标准文档格式.docx》由会员分享，可在线阅读，更多相关《详细设计文档质检标准文档格式.docx（9页珍藏版）》请在冰豆网上搜索。

新建

李雨现

张宇博

特征

子特征

度量项目

评测项

评测细则

评测结果

功能性

完备性

（1）充分性

1）详细设计文档、接口文档描述应完整、清晰、准确。

a）界面设计应详细描述界面原型存放的路径或rp文件。

b）应正确使用PDL语言，能清晰描述各事项业务逻辑。

c）功能接口内容应按照接口文档中的“方法描述+方法编号”方式编写。

d）接口文档的方法描述应与概要设计文档事项功能点动作命名一致。

e）所有详细设计文档的编写风格、细节上应一致。

f）所有接口文档的编写风格、细节上应一致。

2）详细设计文档中的类图、用例图、活动图、时序图制作正确。

a）类图应符合类图绘制原则。

（类图绘制原则见附录）

b）用例图应符合用例图绘制原则。

（用例图绘制原则见附录）

c）功能描述应用活动图展示。

d）活动图应符合活动图绘制原则。

（活动图绘制原则见附录）

e）时序图应符合时序图绘制原则。

（时序图绘制原则见附录）

f）类图风格一致。

g）用例图风格一致。

h）活动图风格一致。

i）时序图风格一致。

3）考虑相关联产品或功能之间的相互影响。

a）前置条件应描述所有的业务规则，包括自身校验，各功能、各产品之间关联。

4）接口文档中的输入输出都应被正确定义和检查。

a）接口文档中数据元素命名规则应符合各产品命名规范。

b）接口文档中节点属性应与中文描述内容一致。

c）接口文档中所有字段的数据类型应使用正确，且满足接口文档中规范要求。

d）接口文档中每个输入字段应确认是否为必输项。

e）接口文档中输入字段的说明应描述详细，能在不沟通的情况下，被开发理解。

f）接口文档中输入字段的说明应有对应示例。

5）数据元素的命名和使用在整个事项和事项接口之间应一致。

a）各事项之间数据元素命名规则应一致。

6）接口文档中不允许存在冗余字段、接口。

a）接口文档中不允许存在冗余接口。

b）接口文档中输入、输出不允许存在冗余字段。

7）应详细说明参数的度量单位、取值范围、正确度和精度。

a）输入与输出在界面原型中应描述字段类型、控制、长度、计量单位、精度等要求。

8）概要设计文档的输入输出项是详细设计文档输入输出项的子集，且两个输入输出项的命名保持一致。

a）接口文档的输入输出项应包含概要设计、界面原型的输入输出项。

b）接口文档的输入输出字段名称应与概要设计、界面原型对应字段名称一致。

9）详细设计文档、接口文档能为开发提供充足的依据。

a）详细设计文档不允许存在歧义、错别字。

b）接口文档不允许存在歧义、错别字。

（2）完整性

1）需求规格说明书中的每个事项应编写对应的详细设计文档、接口文档，且与需求规格说明书、概要设计中功能一致。

a）每个功能都应有对应的详细设计文档、接口文档。

b）每个事项的详细设计文档、接口文档应与需求规格说明书中的功能一致。

2）界面原型中调用的接口信息应填写完整、正确。

a）界面原型中调用的接口信息应是正确的，有对应的接口信息。

3）界面原型中相同字段的长度限制应保持一致，（需要调用接口的）下拉框、按钮应提供接口信息。

a）界面原型中相同字段的长度、类型、计量单位、精度限制应保持一致。

b）（需要调用接口的）下拉框、按钮应提供接口信息，且接口信息正确。

正确性

（3）数据项的正确性

1）应采用数据算法（四舍五入、去尾法、进一法等）确认数据项精度和准确度。

a）界面原型中应描述出数据计算采用的精度算法。

（例如，四舍五入、去尾法等）

依从性

（4）依从性

1）所有的设计元素都应追溯回更高级别的文档。

a）每个设计元素都应可追溯到对应的需求规格说明书。

2）应遵循该项目文档编写标准。

（例如，公司标准、国家标准等）。

a）应按照公司详细设计文档、接口文档模板编写。

b）应遵循法律依据、国家相关制度、属地管理、公司管理相关制度。

可靠性

（5）可靠性

1）应使用接口测试工具测试接口，并记录输入、输出结果。

a）应使用接口测试工具对每个接口进行测试，且调用成功。

注：

评测项说明：

Y-是，N-否，NA-不适用。

附录

类图绘制原则：

（1）应使用类图符号。

类图元素符号定义

符号

说明

类

或

保护（protected）

公有（public）

实现（implementation）

私有（private）

类与类关系符号定义

继承（B类继承了A类）

实现（A类实现了B类）

关联（A类和B类相互调用和访问对方的元素）

关联（单向，A类可以调用和访问B类的元素，但B类不可以访问A类的元素）

聚合（A类拥有一个B类，B类脱离A类后仍可以独立存活）

依赖（B类的变化会影响A类，则A类依赖于B类）

组合（A类拥有一个B类，B类脱离A类后无意义）

（2）类与类之间的关系正确，且表示符号使用正确。

（3）类图中方法、属性命名符合公司java命名规范。

（4）类图中包含对应事项的所有方法，且方法名一致。

（5）类图中不允许存在冗余的方法、属性。

（6）类图符号、字体、字号、底色一致。

用例图绘制原则：

（1）应使用用例图符号。

用例图元素符号定义

参与人

泛化（参与者之间或用例之间的关系）

用例

包含（用例之间关系）

关联（参与者与用例之间的关系）

扩展（用例之间关系）

（2）用例图绘制应采用由左而右的顺序。

（3）参与者与用例关系正确，且表示符号使用正确。

（4）用例之间关系正确，且表示符号使用正确。

（5）用例应覆盖需求上所有功能点。

（6）不允许出现两个以上描述相同的用例。

（7）用例图中的语言应描述简洁、易懂。

（8）用例图符号、字体、字号、底色一致。

活动图绘制原则：

（1）应使用活动图符号。

活动图元素符号定义

开始节点

动作节点

分叉

结束节点

分支

汇合

（2）活动图绘制应采用由上而下的顺序。

（3）一个活动图应以开始节点开始以结束节点结束，且开始节点只能出现一次，但结束节点不限。

（4）应正确使用分支、分叉、汇合。

（5）每个分支应有对应结果，可形成闭环。

（6）活动图应覆盖用例图中的所有用例。

（7）活动图中的语言应描述简洁、易懂。

（8）活动图符号、字体、字号、底色一致。

时序图绘制原则：

（1）应使用时序图符号。

时序图元素符号定义

角色（可以是人或者其他系统、子系统）

异步消息（发送人不需等待消息的响应）

或或

对象

返回消息

生命线（对象在一段时期内的存在）

自关联消息（自身调用自身的方法）

激活

选择组合（组合中的内容可能执行可能不执行，根据条件进行判断）

同步消息（发送人需要等待消息的响应）

替换组合（多个组合中选择一个执行）

（2）时序图绘制应采用由左而右的顺序。

（3）应正确区分消息类别。

（4）时序图包含对应类图中所有方法。

（5）时序图符号、字体、字号、底色一致。

内部资料第9页/共9页版权归河北神玥软件科技股份有限公司所有