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

ICS 35.008L 77Su备案号：12036—2003中华人民共和国电子行业标准SJ/T 11291—2003面向对象的软件系统建模规范第3部分：文档编制Specification of object-oriented software system modelingPart 3: Documentation2003-06-04 发布2003-10-01 实施中华人民共和国信息产业部发布 SJ/T 11291—2003言前《面向对象的软件系统建模规范》系列标准分为三部分：SJ/T11290一2003《面向对象的软件系统建模规范第1部分：概念与表示法》SJ/T XXXX一XXXX《面向对象的软件系统建模规范第2部分：过程指导》SJ/T11291--2003《面向对象的软件系统建模规范第3部分：文档编制》附录 A 是资料性附录。本标准由中国电子技术标准化研究所归口。本标准由北京大学负责起草。本标准主要起草人：麻志毅、蒋严冰、王立福、邵维忠。 SJ/T 11291—2003引言文档是软件的重要组成部分，是对研制过程进行管理的重要手段。文档的形式可以是多种多样的。在面向对象的软件系统建模过程中经常用到的文档，可以是图形的，也可以是文本的。图形文档具有清晰、直观及简练等特点；文本文档具有容易理解、具体及详细等特点。二者相互补充和相互依赖，都是不可少的。在本标准中要求同时使用这两种文档。其中的图形文档的绘制方法在SJ/T 112902003《面向对象的软件系统建模规范第1部分：概念和表示法》中已有了详细的规定。本标准主要规定与各图形文档相对应的文本文档格式。严格地说，尽管图形文档和文本文档的表现形式不同，但其本质内容都是一致的。在编制的过程中要充分地注意到这一点，力求图形文档中的元素和文本文档中的各组成部分一一对应。在每种文本文档中对各个组成部分分类描述，并注重描述不同组成部分的关系，这样就使得文本文档中的组成部分组织严密，便于相关人员从不同的角度使用所需要的组成部分。在图形文档中，为了管理信息组织的复杂度而引入了包的机制。为了更好地用文本的方式描述这种机制，在本标准中用递归的方法描述带有包的文档。本标准对用况图文档、类图文档、顺序图文档、协作图文档、状态图文档、活动图文档、构件图文档、部署图文档和包图文档的格式分别做了详细的描述。对每种文档的结构以及可能包含的组成部分分别出了规定。本标准最后提供了一个样式，以便于有关人员实际操作时参考。 TSJ/T 11291—2003面向对象的软件系统建模规范第3部分：文档编制1范围本标准规定了对面向对象的软件系统建模过程中所生成的文档的编制要求，并给出了编制提示。本部分适用于软件系统的分析和设计，也可采估和维护。ANDARD2 引用标准下列文件中的条款通过本桥准的污用而成为本标准的条款日期的用文件，其随后所有的家修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，鼓励根据本标裤达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版态适用于本标准。2003SJ/T 11290面向对象的软件系统建模规范第1部分：概念转表示法盛王面询对象的软件系统建模规范第2部分：SJ/T XXX程播导ISAAN3文档的编制要求在-向对象的软件系统建模中，一般地说，应产生下列文档：→总体说期文档；C档用况图类图文林顺序图文协作图文机SIONB状态图文档;活动图文档;构件图文档；0部署图文档；其中有的文档有时会引入也图来香理僵意细绿食实开发者也可根据所承担项目的实际情识灵活取合当开发者按照《面向对象的软件系统建模规范第2部分：过程指导》开发软件系统时，可以按开发阶段组织文档，分别形成：需求定义文档、分析文档和设计文档。其中每种文档的内容包含一个或多个上面提到的各种图的文档，具体的要求见《面向对象的软件系统建模规范第2部分：过程指导》。4文档的编写提示4.1总体说明文档以文本方式，对整个系统作一些必要的说明。内容包括系统的目标、意义、应用范围、项目背景和文档组成等。但不必对系统的总体进行详细地说明，只需作提纲挚领式的简单介绍。另外，还要说明系统的建模文档由那几种具体的文档组成、每种文档的份数以及对各种文档的组织等。4.2用况图文档1 SJ/T 11291--20034.2.1图形文档即所绘制的用况图。4.2.2文字说明用况图文档出以下部分组成：用况图综述、参与者描述、用况描述、用况图中元素间的关系描述和其他与用况图有关的说明。用况图综述从总体上阐述整个用况图的目的、结构、功能以及组织。以文字描述文档所包含的部分。参与者描述列出一个用况图中的每个参与者的名称，可按字母顺序或其它某种有规律的次序排列。必要时要对参与者附有必要的文字说明，也可以说明它所涉及到的用况和交互图的名称。用况描述对于个