IT工程师职业基础lecture-10.ppt

信息与软件工程学院 * 软件文档的作用（回顾） 实现者的任务说明 系统的分析基础 自动代码生成规范 系统理解 投资回收 ...... 信息与软件工程学院 * 软件视图 概念：是对一组系统元素及其关系的描述 不同的视图会在不同程度上表现出不同的质量属性。在系统开发过程中，最为关心的质量属性将影响编制文档视图。如，分层视图能反映系统的可移植性，部署实体可以推断系统的性能和可靠性等。 不同的视图也支持不同的目标和用途。应该首先明确文档的预期使用。因为不同的视图会突出不同的系统元素和(或)关系 信息与软件工程学院 * 软件视图的类型 模块视图类型：能为系统主要实现单元编制文档服务 组件和连接器(CC)视图类型：能为系统执行单元编制文档服务 分配视图类型：能为系统软件与其开发和执行环境之间的关系编制文档服务 　　代表系统设计师必须考虑的3种视角：实现单元、运行时执行单元、从软件元素到环境结构的映射。而文档就是要记录这些内容 信息与软件工程学院 * 模块视图类型 系统软件分解成可管理单元的方式仍然是重要的系统结构形式之一 建议：编制一个完整的软件文档时，应该至少采用一个模块视图类型的视图 文档风格：分解、使用、泛化、分层 每一种风格都能对基本模块视图类型进行限制 信息与软件工程学院 * 例：四类风格 信息与软件工程学院 * CC视图类型 为系统执行单元编制文档服务 任何特定的组件或连接器都能以多重CC视图的形式编制文档。例如，作为C/S系统中的服务器组件，也可作为数据储存库（共享存储）。 组件和连接器视图类型可通过许多风格得到特化。例如，粗粒度的早期设计决策被进一步精化后，就可能包含需要在以后得到精化的抽象连接器类型。 信息与软件工程学院 * 例：CC视图类型 视图类型 风格 视图 CC 管道与过滤器 客户机－服务器 …… 共享数据 你的风格 管道与过滤器视图 共享数据视图 你的视图 信息与软件工程学院 * 分配视图类型 在软件系统开发过程中，硬件、文件系统和团队结构都会与软件系统的结构发生关系，进行交互。所以，也必须为这类交互编制相关文档 部署风格。描述组件和连接器(CC)对硬件的映射，硬件是软件执行的场所。 实现风格。描述模块对包含它们的文件系统的映射 工作任务风格：描述模块与承担者的关系 信息与软件工程学院 * 部署风格 调度器 服务器：主机 databass 会议数据库 软件 客户机：PC机 Direct channel 信息与软件工程学院 * 实现风格 A make src A.cc include A.h doc A.doc config A.conf A make 图例： 具有模块名称的文件夹 文件 包容 信息与软件工程学院 * 工作任务风格 序号 岗位 人数 职责 1 项目经理 1 项目整体规划、设计、管理；项目计划、总体设计等 2 需求分析 2 客户沟通，收集需求，确定应用原型；需求规格说明书 3 模块负责 1 手机端模块的设计、开发、管理；设计开发文档 1 服务器端模块的设计、开发、管理；设计开发文档 1 其他功能管理模块的设计、开发、管理；设计开发文档 4 接口与DB 2 数据采集、接口设计实现、数据库设计实现 5 编码 4 代码实现、白盒测试；开发文档 6 界面 1 界面设计、美工；界面操作文档 7 测试 3 模块测试、集成测试、系统测试等；相关测试文档及测试报告 8 培训 1 对使用人员的培训；使用手册等 信息与软件工程学院 第四章 第十讲软件文档的类型、标准与规范 第四章软件文档写作 文档写作概要 软件文档的类型、标准与规范 开发类文档写作 用户类文档写作　　 软件文档的类型、规范、标准 信息与软件工程学院 * 本节的目的 了解软件文档写作的相关标准：国际、国家、行业、公司等 了解软件技术文档的各种类型、风格 了解软件文档编制的原则、需遵守的规范 了解软件文档的特定表达方法 ISO 国际标准 信息与软件工程学院 * ISO 9000国际标准 ISO：International Organization for Standardization 宗旨：在世界上促进标准化及其相关活动的发展，以便于商品和服务的国际交换，在智力、科学、技术和经济领域开展合作 国际认同：市场经济，特别是国际贸易的驱动 信息与软件工程学院 * 产品 实 现 组织 目 的 来 源 顾客