7.5系统文档编制和实现、测试 7.5.1编制设计文档 在面向对象软件设计中,各个阶段的成果都有需要及时地以文档形式记录出来,以方便 下一阶段的使用及为客户、用户或经销商服务 如果一个文档是面向客户的,最关心的问题就是系统的功能如何。因此文档编制应从描 述系统用途开始,紧接着描述一系列的用户场景或事件一响应模型。文档应当说明目标系统 的范围以及系统所接收和产生的信息,并让读者遍历每一个场景或事件,一步一步地验证事 件是如何被识别的,相关联的响应是如何产生的。为了使文档清晰明了,应当将属性和服务 的定义以及细节的描述以字母的顺序进行排序,一些分层的列表可以放在文档附录中 系统契约、 范围等 用户场景 2345 用ER0I图描 述系统行为 (1) (3) 用对象图描述系统行为 词典 各种支持细节、包括数据定 务定义和相关描述 图7.15面向用户文档的一般结构 如果文档所面向的对象是软件设计者,最关心的问题是系统的结构,而不是系统的行为。 因此在这种设计文档中应当给出完整的五层OOA模型。而表现模型的一个有效的方法是将 OOA模型表现为一组主题集。如果能用单个图表就可以将主题表示出来,则这组主题及其 基本的细节内容就能提供一个OOA模型的书面形式。为了将各个主题联系起来,表示一个 完整的系统模型,在这类文档的开头应当提供一个所有主题和一览。图7.16给出了这种面 向设计者的设计文档的一般结构。在该结构中,每个类都用单独的一页进行描述。类或成分7．5 系统文档编制和实现、测试 7．5．1 编制设计文档 在面向对象软件设计中，各个阶段的成果都有需要及时地以文档形式记录出来，以方便 下一阶段的使用及为客户、用户或经销商服务。 如果一个文档是面向客户的，最关心的问题就是系统的功能如何。因此文档编制应从描 述系统用途开始，紧接着描述一系列的用户场景或事件—响应模型。文档应当说明目标系统 的范围以及系统所接收和产生的信息，并让读者遍历每一个场景或事件，一步一步地验证事 件是如何被识别的，相关联的响应是如何产生的。为了使文档清晰明了，应当将属性和服务 的定义以及细节的描述以字母的顺序进行排序，一些分层的列表可以放在文档附录中。 如果文档所面向的对象是软件设计者，最关心的问题是系统的结构，而不是系统的行为。 因此在这种设计文档中应当给出完整的五层 OOA 模型。而表现模型的一个有效的方法是将 OOA 模型表现为一组主题集。如果能用单个图表就可以将主题表示出来，则这组主题及其 基本的细节内容就能提供一个 OOA 模型的书面形式。为了将各个主题联系起来，表示一个 完整的系统模型，在这类文档的开头应当提供一个所有主题和一览。图 7．16 给出了这种面 向设计者的设计文档的一般结构。在该结构中，每个类都用单独的一页进行描述。类或成分