SJ T 11291-2003 面向对象的软件系统建模规范 第3部分 文档编制.pdf

《SJ T 11291-2003 面向对象的软件系统建模规范 第3部分 文档编制.pdf》由会员分享，可在线阅读，更多相关《SJ T 11291-2003 面向对象的软件系统建模规范 第3部分 文档编制.pdf（15页珍藏版）》请在麦多课文档分享上搜索。

1、一ICS 35.s L 77 备案号:12036-2003 华共和SJ/T 11291 2003 Specification of object-oriented software system modeling P红t3: Documentation 2003-06-04发布2003-10-01 中华人民共和国信息产业部发布一自IJ面向对象的软件系统建模规范系列标准分为三部分:SJ厅1129-23面向对象的软件系统建模规范第1部分z概念与表示法SJ厅xxxx-x口x面向对象的软件系统建模规范第2部分z过程指导SJ厅11291-23面向对象的软件系统建模规范第3部分z文档编制附录A是资料性附录

2、。本标准由中国电子技术标准化研究所归口。本标准由北京大学负责起草。本标准主要起草人2麻志毅、蒋严冰、王立福、邵维忠。SJ/T 11291-2003 I SJ/T 11291-2003 引文档是软件的重要组成部分，是对研制过程进行管理的重耍手段。文档的形式可以是多种多样的。在面向对象的软件系统建模过程中经常用到的文挡，可以是图形的，也可以是文本的。阁形文档具有清晰、直观及简练等特点:文本文档具有容易理解、具体及详细等特点。二者相互补充和相互依赖，都是不可少的。在本标准中要求同时使用这两种文档。其中的图形文档的绘制方法在SJ厅1129023 而向对象的软件系统建模规范第1部分z概念和表示法中已有了

3、详细的规定。本标准主要规定与各图形文档相对应的文本文档格式。严格地说，尽管图形文档和文本文挡的表现形式不同，但其本质内容都是一致的。在编制的过程中要充分地注意到这一点，力求图形文档中的元索和文本文档中的各组成部分一一对应。在每种文本文档中对各个组成部分分类描述，并注重描述不同组成部分的关系，这样就使得文本文档中的组成部分组织严密，便于相关人员从不同的角度使用所需要的组成部分。在图形文档中，为了管理信息组织的复杂度而引入了包的机制。为了更好地用文本的方式描述这种机制，在本标准中用递归的方法描述带有包的文档。本标准对用况图文档、类图文档、顺序图文档、协作图文档、状态图文档、活动图文档、构件图文档、

4、部署图文档和包图文档的格式分别做了详细的描述。对每种文档的结构以及可能包含的组成部分分别出了规定。本标准最后提供了一个样式，以便于有关人员实际操作时参考。E SJ/T 11291-2003 面向对象的软件系统建模规范3部分:范围本标准规定了对面向对象的软件系统建摸过程中所生成的文档的编制要求，并给出了编制提示。本部分适用于软件系统的分析和设计，2 引用标准修改单(不包括勘是否可3 S1.厅lSJ，厅状态阁文档构件图文档:其中有的文档有时会寻开发者也可根据所承担项目，当开发者按照面向对象的软件系统建模规范发阶段组织文档，分别形成z需求定义文档、分析文档和设计文档。文件，其随后所有的的各方研究第2

5、部分:过程指导开发软件系统时，可以按开其中每种文档的内容包含一个或多个上面提到的各种图的文档，具体的要求见面向对象的软件系统建摸规范第2部分:过程指导队4 文挡的编写提示4. 1 总体说明文档以文本方式，对整个系统作一些必要的说明。内容包括系统的目标、意义、应用范围、项目背景和文档组成等。但不必对系统的总体进行详细地说明，只需作提纲享领式的简单介绍。另外，还要说明系统的建模文档由那几种具体的文档组成、每种文挡的份数以及对各种文档的组织等。4.2 1 SJ!T 11291-2003 4. 2. 1 图形文档即所绘制的用况图。4.2.2 文字说明用况图文档由以下部分组成:用况图综述、参与者描述、用

6、况描述、用况图中元素间的关系描述和其他与用况图有关的说明。4.2.2.1 用况图综述从总体上阐述整个用况图的日的、结构、功能以及组织。以文字描述文档所包含的部分。4.2.2.2 参与者描述列出一个用况图巾的每个参与者的名称，可按字母顺序或其它某种有规律的次序排列。必要时要对参与者附有必要的文字说明，也可以说明它所涉及到的用况和交互图的名称。4.2.2.3 用况描述对于一个用况图中的每个用况，记录如下的信息。要按某种顺序排列它们。的名称每个用况有个在图内唯-的名字，并且该名字要反映出它所描述的功能。书写位置是在用况描述的第一行。b) 行为描述用自然语言分别描述参与者的行为和系统行为，建议把参与者

7、的行为靠左对齐书写，把系统行为靠较右的位置对齐书写。在描述较复杂的含有循环或条件分支的行为时，可使用一些结构化编程语言的控制语句，直口while. for. if-then-else等。当要表明控制语旬的作用范围时，可使用招号，如、或begin、end等，也可以使用标号，以便更清楚地表示控制走向。如有必要，可佼用顺序阁、状态图或协作图描述参与者的行为和系统行为。c) 用况图中元素间的关系描述产生一份描述用况图中的参与者与用况间、用况间以及参与者问关系的文字性描述文档。具体地由下面几部分构成21) 关系的名称:2) 关系的类型:关联，泛化，包含，扩展:3) 关系所涉及的类比对关系所连接的类日应指

8、明名称和类型(参与者或用况。d) 其他与用况图有关的说明与该用况图有关的但上面文档中没有涉及的其他信息的描述。4.3 类图文档4. 3. 1 图形文档即所绘制的类图。4.3.2 文字说明文字描述由以下部分组成g类图综述、类描述、关联描述、泛化描述、依赖描述和其他与类图有关的说明。在实际使用时，这些部分是可选的。4. 3. 2. 1 从总体上阐述整个类图的目的、结构、功能及组织。以文字描述文档所包含的部分。4.3.2.2 类描述类描述包括类整体说明、周性说明、服务说明、关联说明、泛化说明、依赖说明及其他说明。a) 类的整体说明对整个类及其对象的情况加以说明，内容包括:2 SJ/T 11291-2

9、003 类名z应是中文名或英文名;解释z对类的责任的文字描述，一般类:描述该类是从那些类泛化而来的:状态转换图:描述该类的实例的状态图的名称列表:主动性:有无主动性:永久性:有无永久性:引用情况s若此类为其它类图所定义，则要标明它所属于的类图:若此类被其它类图引用，则标明所引用的类图:日)多重性9) 其它2是否有特别的属性说明逐个地说明1) 属性名2) 3) 4) 5) 6) 7) ) 1丰句，qA哇bnb巧tb) 则在这里时间的要求等其它需要说叫田z该属8) 逐OD日创c) 明的事项，关联描述该类所涉及的所有的关联。每个与该类相关的关联可有关联名。泛化描述该类所涉及的所有的泛化。每个与该类相

10、关的关联可有泛化名。依赖描述该类所涉及的所有依赖。每个与该类相关的依赖可有依赖名。4.3.2.3 关联描述类图中的每一关联都应有如下的描述za) 关联名称:中文关联名或英文关联名:b) 关联的类型2应是一般二元关联，聚合，组合，多元关联，自关联，限定关联，导出关联，其他关联:关联所连接的类:按照一定顺序列举出关联所连接的类:关联端点:对每一个关联端点描述如下:d) e) f) c) d) 3 SJ/T 11291-2003 1) 导航性2是否有导航性:2) 排序:是否排序:3) 聚合z是否有聚合，如果有，则要指明是聚合还是组合;4) 多重性:5) 可变性z应是无、只增加、冻结;6) 角色:角色

11、名用中文名和英文名表示均可。7) 可见性z用+、-、#表示，8) 接口说明符4.3.2.4 泛化描述类图中的每一个泛化都有如下的描述za) 泛化关系中的父类:b) 泛化关系中的子类:c) 泛化关系中的区分器:d) 泛化关系中的限制符:应是完全、不完全、重叠和不相交。4.3.2.5 依赖描述类图中的每一个依赖都有如下的描述:a) 依赖名称:b) 依赖所涉及的类的名称:c) 依赖的类型:d) 依赖的附加说明。4.3.2.6 其他描述文档与该类图有关的但上面文档中没有涉及的其他信息的描述。4.4 4. 4. 1 图形文档ftPI开绘制的顺序图。4.4.2 文字说明顺序图的文字说明文档应包含g顺序阁综

12、述、顺序图中的对象与参与者描述、对象接收/发送信息的描述和其他与顺序图有关的说明。4.4.2.1 从总体上描述该顺序图的目的，以及所涉及的对象和参与者。4.4.2.2 顺序图中的对象与参与者描述对顺序图中的所有的对象和参与者，依次进行如下的描述:a) 对象类型:是参与者还是类:b) 对象名称:c) 是否为主动对象z是或否，此描述针对对象而言，对于参与者不应有此描述:d) 其他与对象或参与者有关的信息。4.4.2.3 对象接收发送消息的描述中的每一个对象或参与者，详细地描述其接收/发送消息的类型、时序及与其他消息之间的触发关系。对每一个对象和参与者应按照时间顺序分别列出该对象或参与者所接收/发送

13、的全部消息。对每一条消息应包含下面的内容:a) 消息名称:b) 是发送消息还是接受消息:c) 消息类型:4 -d) 若为接收消息，应列出该消息所直接触发的消息的名称列表:e) 是否为自接收消息:f) 消息的发送对象名称:g) 消息的接收对象名称。4.4.2.4 其他与顺序图有关的说明与顺序图有关的补充信息，4. 5 4. 5. 1 图形文档即所绘制的协4.5.2文字说明。协作图的文字说明应包发送消息的描述、4.5.2.1 从总4.5.2.2 对协作a)名b) c) d) 4.5.2.3 息的a) b) 1) 2) 3) 4) 消息类型:5) 若为接收消6) 是否为自接收消息:叫7) 消息的发送

14、类目角色或实例:8) 消息的接收类日角色或实例。4.5.2.4 对象或角色间的链描述及的对象或类元角出下面的各项t对象间或角色间的链应由下面的成分构成2a) 链名称:b) 链所连接的角色或对象的名称:c) 链上的角色名，每个角色应包含下列信息:1) 角色名:中文名或英文名:2) 可见性:+、-或#:SJ/T 11291-2003 色描述、对象或角色接收/以及与其他消3) 特殊的衍型:Global、Local、Parameter、Self、Vote、Broadcast:d) 其他与链有关的信息。4.5.2.5 其他与协佑图有关的说明5 SJ/T 11291-2003 与协作图有关的补充信息。4.

15、 6 状态图文档4. 6. 1 图形文档即所绘制的状态图。4. 6. 2 文字说明状态图的文字说明应包含:状态图综述、状态图的状态描述、状态图的转换描述和其他与状态图有关的说明。4.6.2.1 从总体上，及设置该状态图的目的等。4.6.2.2 状态图的状态描述描述一个状态图的所有的状态，对每一个具体状态应包括以下各项za) 状态的名称:中文名或英文名:b) 状态的类型:简单状态，并发组合状态，顺序组合状态，子状态，初始伪状态，终状态，结合状态，历史状态，引用状态，桩状态，同步状态:入口动作:出口动作:内部转换z由一系列的内部转换项组成。每个内部转换项有下列格式:动作标号/动作表达式:f) 若为

16、组合状态应列举出其所包含的子状态:g) 其它与该状态有关的信息。4.6.2.3 状态图的转换描述本文档用来描述一牛业a) 转换的源状态:b) 转换的目标状态:c) 转换串:事件特征标记，监护条件汀，/ d) 转换中的分支z同步条、结合点、动态选择点。4.6.2.4 其他与状态图有关的说明与状态图有关的补充信息。4. 7 4. 7. 1 图形文档即所绘制的活动图。4.7.2 文字说明活动图的文字说明包含:活动图综述、活动图中的动作状态描述、活动图中的转换描述和其他与活关的说明。4. 7. 2. 1 从总体上，活动图描述一个对象的一个操作的活动序列，或者是多个对象为完成某一目的而进行的协作所涉及的

17、活动序列，以及设置该活动图的目的等。若活动图用于描述系统的其他目的，也按本格式描述。4.7.2.2 活动图中的动作状态描述本文档用来描述一个活动图的所有的动作状态，每个具体动作状态包括以下内容2a) 名称:中文名或英文名:b) 类型z一般动作状态，子动作状态，信号发送，信号接收，初始伪动作状态，终动作状态，历史状态:对象在外部激励的作用下进行的状态变迁、所涉及到的状态和转换以) CJoe 的所有的状态转换，每一个具体转换应包括以下各项z动作表达式:6 SJ/T 11291-2003 c) 入口转换:d) 出口转换:e) 活动伪码:的其它与该状态有关的信息。4.7.2.3 活动图中的转换描述本文

18、档用来描述一个活动图的所有的转换，每一个具体转换包括以下内容za) 转换的名称:b) 源动作状态:c) 终动作状态:d) 转换中的分支:包括分叉、同e) 转换中的控制分叉24.7.2.4 4.8.2.1 从总4.8.2.2 构件图a) b) c) d) e) 4.8.2.3构件图a) 关系的名称:b) 关系的起c) 关系的结束构件的名称:d) 关系的类型z实现依赖、使用依赖或其他依赖。4.8.2.4其他与构件图有关的说明其他与构件图有关的信息。4.9 4.9.1 图形文档即所绘制的部署图。4.9.2 文字说明口和出口元素的名称。部署图的文字说明文档包含z部署图综述、部署图中的节点描述、部署图中

19、的关系描述和其他与部署图有关的说明。4.9.2.1 部署图综述从总体上描述部署图的目的以及节点之间的相互关系等。4.9.2.2部署图中的节点描述7 SJ/T 11291-2003 中的每一个节点包含下列描述:a) 节点名称:b) 节点中的构件实例:c) 节点所涉及的链的名称:d) 节点的类型。4.9.2.3 部署图中的关系描述a) 关系的名称:b) 关系的起始节点(或构件)的名称:c) 关系的结束节点(或构件的名称:d) 关系的类型:实现依赖、使用依赖、其他依赖或通讯链。4.9.2.4 其他与部署图有关的说明其他与部署图有关的信息。4. 10 包图文档为了管理模型的信息组织的复杂性，在比较复杂

20、的模型巾，通常将关系联系比较密切的图形元素划分到一个包里面。最常见的是在用况图和类图中使用包图。一般情况下，包图与前面提到的几种图搭配使用，而不单独使用。4. 10. 1 图形文档即所绘制的包图。4. 10. 2 文字说明包图的文字说明文档包含:包图的综述、包图中的包括述和其他与包图有关的说明。4.10.2.1 包图的综述从总体上描述包图的名称、日的以及与其他包的相互关系等。4.10.2.2 包图中的包描述包图中的每一个包包含下列描述:a) 包的名称:b) 包的种类2类包、用况包或其他:c) 详细描述该包所包含的建模元素所在的文档:d) 与该包有关系的其他包，应包括如下信息z1) 包的名称:2

21、) 与该包的关系:依赖(访问和移入)、泛化，要注明方向性。4.10.2.3 其他与包图有关的说明其他与包图有关的信息。8 SJ/T 11291-2003 附录A(资料性附录)文档编写样式文挡的封面格式A. 1 文档的封面格式如下:计阳、h时(需求、档xx 币。一町一编写单位写人校对人9 编写日期SJ/T 11291-2003 A.2 文档内容格式文档内容格式如下:文挡的总体说明1. 1 日的1. 2 意义1. 3 应用范围1. 4 项目背景1. 5 文档组成2 本文裆由以下部分组成:包图文档用况图文档:类图文档:顺序图文档:协作图文档:状态图文档:活动图文档:构件图文档;部署图文档。包树结构文

22、档描述按系统的要求已经构造的包树结构。3 10 按如包图文档图形文挡文字说明用况图文档图形文档文字说明类图文档图形文档文字说明顺序图文档文字说明文字说明状态图文档图形文档文字说明。活动图文档图形文档文字说明构件图文档图形文档文字说明部署图文档图形文档文字说明注:根据需要，可以在包树文档中建立构组织aSJ/T 11291-2003 也可以把各图文档按包树的结11 。ON-FON-户，中华人民共和国电子行业标准面向对象的软件系统建模规范第3部分z文档编制SJ/T 11291-2003 * 户的民川训忖-dIJ片Emf出印发中国电子技术标准化研究所中国电子技术标准化研究所中国电于技术标准化研究所电话，(010) 84029065 传真，(010) 647812 地址z北京市安定门东大街1号邮编，100007 网址z阳啃ces1.ac. cn 字数，30千字印张:旦16 2003年8月第一次印刷1000册* 1/16 开本880X 1230 2003年8月第一版印数:版权专有不得翻印举报电话:(010) 64007804