SJ ICS 35.008 L 77 备案号：12036—2003 中华人民共和国电子行业标准 SJ/T11291—2003 面向对象的软件系统建模规范 第3部分：文档编制 Specification of object-oriented software system modeling Part 3: Documentation 2003-06-04发布 2003-10-01实施 中华人民共和国信息产业部发布 SJ/T11291—2003 前 《面向对象的软件系统建模规范》系列标准分为三部分： SJT11290一2003《面向对象的软件系统建模规范第1部分：概念与表示法》 SJ/TXXXX一XXXX《面向对象的软件系统建模规范第2部分：过程指导》 SJT11291-2003《面向对象的软件系统建模规范第3部分：文档编制》 附录A是资料性附录。 本标准由中国电子技术标准化研究所归口。 本标准由北京大学负责起草。 本标准主要起草人：麻志毅、蒋严冰、王立福、邵维忠。 SJ/T11291—2003 引 言 文档是软件的重要组成部分，是对研制过程进行管理的重要手段。文档的形式可以是多种多样的。 在面向对象的软件系统建模过程中经常用到的文档，可以是图形的，也可以是文本的。图形文档具有清 晰、直观及简练等特点；文本文档具有容易理解、具体及详细等特点。二者相五补充和相互依赖，都是 不可少的。在本标准中要求同时使用这两种文档。其中的图形文档的绘制方法在SJ/T11290一2003《面 向对象的软件系统建模规范第1部分：概念和表示法》中已有了详细的规定。本标准主要规定与各图 形文档相对应的文本文档格式。 严格地说，尽管图形文档和文本文档的表现形式不同，但其本质内容都是一致的。在编制的过程中 要充分地注意到这一点，力求图形文档中的元素和文本文档中的各组成部分一一对应。在每种文本文档 中对各个组成部分分类描述，并注重描述不同组成部分的关系，这样就使得文本文档中的组成部分组织 严密，便于相关人员从不同的角度使用所需要的组成部分。 在图形文档中，为了管理信息组织的复杂度而引入了包的机制。为了更好地用文本的方式描述这种 机制，在本标准中用递归的方法描述带有包的文档。 本标准对用况图文档、类图文档、顺序图文档、协作图文档、状态图文档、活动图文档、构件图文 档、部署图文档和包图文档的格式分别做了详细的描述。对每种文档的结构以及可能包含的组成部分分 别出了规定。本标准最后提供了一个样式，以便于有关人员实际操作时参考。 SJ/T11291—2003 面向对象的软件系统建模规范 第3部分：文档编制 1范围 本标准规定了对面向对象的软件系统建模过程中所生成的文档的编制要求，并给出了编制提示。本 部分适用于软件系统的分析和设计， 估和维护。 2引用标准 下列文件中的条款通过本标准的 的用而成为本标准的条款 日期的引用文件，其随后所有的 修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究 是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本标准。 SJ/T11290 -2003 面向对象的软件系统建模规范第1部分：概念针表示法 面询对象的软件系统建模规范第2部分：程指导 SJ/TXXX 文档的编制要乐 面向对象的软件系统建模中，-般地说，应产生下列文档： 总体说 月文档： 期 档 用况图 类图文楼 顺序图文 S 协作图文档 状态图文档： 活动图文档； 构件图文档； 部署图文档： 开发者也可根据所承担项目的实际情况 活取 当开发者按照《面向对象的软件系统建模规范第2部分：过程指导》开发软件系统时，可以按开 发阶段组织文档，分别形成： 需求定义文档、分析文档和设计文档。 其中每种文档的内容包含一个或多个上面提到的各种图的文档，具体的要求见《面向对象的软件系 统建模规范第2部分：过程指导》。 4文档的编写提示 4.1总体说明文档 以文本方式，对整个系统作一些必要的说明。内容包括系统的目标、意义、应用范围、项目背景和 文档组成等。但不必对系统的总体进行详细地说明，只需作提纲挚领式的简单介绍。另外，还要说明系 统的建模文档由那几种具体的文档组成、每种文档的份数以及对各种文档的组织等。 4.2用况图文档 SJ/T11291—2003 4.2.1图形文档 即所绘制的用况图。 4.2.2文字说明 用况图文档由以下部分组成：用况图综述、参与者描述、用况描述、用况图中元素间的关系描述和 其他与用况图有关的说明。 4.2.2.1用况图综述 从总体上阐述整个用况图的目的、结构、功能以及组织。以文字描述文档所包含的部分。 4.2.2.2参与者描述 列出一个用况图中的每个参与者的名称，可按字母顺序或其它某种有规律的次序排列。必要时要对 参与者附有必要的文字说明，也可以说明它所涉及到的用况和交互图的名称。 4.2.2.3用况描述 对于一个用况图中的每个用况，记录如下的信息。要按某种顺序排列它们。 a）名称 每个用况有一个在图内唯一的名字，并且该名字要反映出它所描述的功能。书写位置是在用况 描述的第一行。 b) 行为描述 用自然语言分别描述参与者的行为和系统行为，建议把参与者的行为靠左对齐书写，把系统行 为靠较右的位置对齐书写。 在描述较复杂的含有循环或条件分支的行为时，可使用一些结构化编程语言的控制语句，如 while，for，if-then-else等。 当要表明控制语句的作用范围时，可使用括号，如{、或begin、end等，也可以使用标号， 以便更清楚地表示控制走向。 如有必要，可使用顺序图、状态图或协作图描述参与者的行为和系统行为。 c) 用况图中元素间的关系描述 产生一份描述用况图中的参与者与用况间、用况间以及参与者间关系的文字性描述文档。具体 地由下面几部分构成： 1）关系的名称； 2）关系的类型：关联，泛化，包含，扩展； 3）关系所涉及的类日：对关系所连接的类目应指明名称和类型（参与者或用况）。 其他与用况图有关的说明 d) 与该用况图有关的但上面文档中没有涉及的其他信息的描述。 4.3类图文档 4.3.1图形文档 即所绘制的类图。 4.3.2文字说明 文字描述由以下部分组成：类图综述、类描述、关联描述、泛化描述、依赖描述和其他与类图有关 的说明。在实际使用时，这些部分是可选的。 4.3.2.1类图综述 从总体上阐述整个类图的目的、结构、功能及组织。以文字描述文档所包含的部分。 4.3.2.2类描述 类描述包括类整体说明、属性说明、服务说明、关联说明、泛化说明、依赖说明及其他说明。 a）类的整体说明 对整个类及其对象的情况加以说明，内容包括： 2 SJ/T11291—2003 1) 类名：应是中文名或英文名； 解释：对类的责任的文字描述； 3) 一般类：描述该类是从那些类泛化而来的； 4) 状态转换图：描述该类的实例的状态图的名称列表； 5) 主动性：有无主动性； 永久性：有无永久性； 7) 引用情况：若此类为其它类图所定义，则要标明它所属于的类图；若此类被其它类图引用， 则标明所引用的类图； 8) 多重性 b) 属性说明 逐个地说明类的属性。 S 属性名： 布文赢糕名或英文属性名： 2) 多重 该属性的多重性； 3) 解群： 该属性的作用； 4) 数据类型： 则秘这旱说明这种关系： 5) 聚合美系 如果这个属性的作用是为了表明聚合关系， 6) 关关系：如巢择个属性是为于实现该类的对象和其它对象之间由链雨投 7) 翼的，则在这里 S 明确地说明这一点； 8 实现要求： 该成性的取值范围、精 初始值及其它描述 INDI c) 服务 说明 逐个 类中的每个服务。每个服务的详轴说明包括以本！ 地说明类 1) 文服务名或英文服务名 2) 3) 多表性 有无多态性； 解释：该事务的作用： 4) 服务的洁动图：详细描述活动具体细节的活动图的名称双表 5) 约束条件及其它：读服务的执行有前置条件、后翼条供或批行时间的要求等其它需要说 6) 明的事项，则在此说明。 d) 关联 描述该类所涉及的所有的关联。每个与该类相关的关联可有关联名。 e) 泛化 描述该类所涉及的所有的泛化。每个与该类相关的关联可有泛化名。 f) 依赖 描述该类所涉及的所有依赖。每个与该类相关的依赖可有依赖名。 4.3.2.3 关联描述 类图中的每一关联都应有如下的描述： a) 关联名称：中文关联名或英文关联名； b) 关联的类型：应是一般二元关联，聚合，组合，多元关联，自关联，限定关联，导出关联，其 他关联： c) 关联所连接的类：按照一定顺序列举出关联所连接的类： d) 关联端点：对每一个关联端点描述如下： 3 SJ/T11291—2003 1) 导航性：是否有导航性； 2) 排序：是否排序； 3） 聚合：是否有聚合，如果有，则要指明是聚合还是组合； 4） 多重性； 可变性：应是无、只增加、冻结； 6) 角色：角色名用中文名和英文名表示均可。 7) 可见性：用+、一、#表示， 接口说明符 8) 4.3.2.4泛化描述 类图中的每一个泛化都有如下的描述： 泛化关系中的父类； b) 泛化关系中的子类； c) 泛化关系中的区分器； d) 泛化关系中的限制符：应是完全、不完全、重叠和不相交。 4.3.2.5依赖描述 类图中的每一个依赖都有如下的描述： 依赖名称； a) b) 依赖所涉及的类的名称； c) 依赖的类型： (P 依赖的附加说明。 4.3.2.6其他描述文档 与该类图有关的但上面文档中没有涉及的其他信息的描述。 4.4顺序图文档 4.4.1图形文档 即所绘制的顺序图。 4.4.2文字说明