文档互评.doc

PhoneMe 需求和设计文档评审 coollemon 小组 孙路 韩露 张龙 李钧 版本：R3 最后修订：2009-4-26 目录 目录 2 修订记录 3 1 综述 4 2 文档结构完整性 4 2.1 目录的详细程度不够，没有列出更细的子目录 4 2.2 目录结构不合理 5 2.3 对于普通标签和关系标签的定义不完整 5 2.4 需求文档中的所有功能描述不完整 6 2.5 功能的流程描述不完整 6 2.6 非功能部分描述不完整 8 2.7 设计文档中没有层次结构图 9 3 需求和设计的合理性与必要性 9 3.1 部分地方描述不精确，需要更加精准的定义 9 3.2 部分地方存在多余的描述语句 10 3.3 部分地方描述过于繁琐，层次不清 10 4 需求、用例图、序列图和类图的一致性与完整性 12 4.1 目录序号与正文中的序号不一致 12 4.2 用例图的用例混乱，分类不清 13 4.3 功能介绍的顺序不一致 14 4.4 设计文档中各个图均缺少必要的文字说明 15 4.5 view包中的类中缺少主要函数的说明 15 4.6 包间的关系图和包内的关系图不一致 16 5 界面、逻辑和数据之间的层次关系 17 5.1 缺少层次关系图 17 6 数据库/数据文件设计及包、类设计的颗粒度等 17 6.1 序列图中的“GUI”颗粒度过大 17 7 各类图表的使用规范 18 7.1 序列图中的类的表示问题 18 7.2 设计文档中所有的信息返回都应该用虚箭头表示。 19 7.3 所有的自我调用表达不规范 20 所有的自我调用序列都应该添加一个新的生命周期（方块） 20 7.4 序列图中的文字表达不正确和不清楚 21 8 其他 22 8.1 部分地方出现错别字 22 修订记录 版本 修订者 描述 修订日期 R1 韩露 创建文档，写入例会讨论结果 2009年4月24日 R2 孙路 文档整理 2009年4月25日 R3 韩露 文档整理，修改举例和附图等格式 2009年4月26日 综述 Growing Group小组的需求文档过于简单的表达phoneMe的主要需求。而且在表达规范和完整性以及一致性上仍有待提高。整个需求文档不能很清晰的传达给用户目标软件的功能。 分析文档的主要问题在于绘图时的规范问题比较严重，大量的图缺少文字说明，并且有不少图的表达过于简单，含义不清晰。 下面将从文档结构完整性，需求和设计的合理性与必要性，需求、用例图、序列图和类图的一致性与完整性，界面、逻辑和数据之间的层次关系，界面、逻辑和数据之间的层次关系，数据库/数据文件设计及包、类设计的颗粒度，各类图表的使用规范，其他等七个方面对Growing Group小组的文档进行详细的评述。 文档结构完整性 目录的详细程度不够，没有列出更细的子目录 需求文档中的 等都没有出现在目录中 目录结构不合理 基本功能和扩展功能应在功能需求分析的目录下。而功能分析和非功能分析平级。 对于普通标签和关系标签的定义不完整用户无法从描述中得知标签的准确功能和特性，理解上会产生歧义。 需求文档中的所有功能描述不完整所有的功能描述都缺少以下两个方面： .前置条件 .后置条件（包括成功场景和失败场景） 功能的流程描述不完整 该处未指出“选择要删除的联系人”的具体位置和操作方法。 该处未指出如何选择查询方式，并且没有指出支持哪些查询方式。 该处未指出如何选择统计方式，并且没有指出支持哪些统计方式。 该处的“简单的容错机制”描述过于简单。 需求文档第7页 该处应指出如何提醒，在何处提醒。 【附图】 非功能部分描述不完整 需求文档第8页中的“”描述不清 设计文档中没有层次结构图 需求和设计的合理性与必要性 部分地方描述不精确，需要更加精准的定义 需求文档中第4页电话号码格式的描述 “” 【附图】 部分地方存在多余的描述语句 需求文档第4页 “” 【附图】 部分地方描述过于繁琐，层次不清 需求文档第6页多用户支持部分 需求文档第7页1.2个人页面管理 需求、用例图、序列图和类图的一致性与完整性 目录序号与正文中的序号不一致 用例图的用例混乱，分类不清 需求分析中的用例图中： .用户位置不规范 .缺少数据库等actor模块 .用例之间的关系不正确，比如“用户登录”与其他功能不应该有用例关系。 .功能分类太粗 设计文档中的用例图： 整体用例图中没有边界，不符合规范 功能介绍的顺序不一致 用户注册