您好,欢迎访问三七文档
当前位置:首页 > 建筑/环境 > 工程监理 > IT工程师职业基础lecture-10
第四章第十讲软件文档的类型、标准与规范第四章软件文档写作•文档写作概要•软件文档的类型、标准与规范•开发类文档写作•用户类文档写作软件文档的类型、规范、标准信息与软件工程学院4本节的目的•了解软件文档写作的相关标准:国际、国家、行业、公司等•了解软件技术文档的各种类型、风格•了解软件文档编制的原则、需遵守的规范•了解软件文档的特定表达方法ISO国际标准信息与软件工程学院6ISO9000国际标准•ISO:InternationalOrganizationforStandardization•宗旨:在世界上促进标准化及其相关活动的发展,以便于商品和服务的国际交换,在智力、科学、技术和经济领域开展合作•国际认同:市场经济,特别是国际贸易的驱动信息与软件工程学院7产品实现组织目的来源顾客关键质量管理体系软件质量硬件设备、能源技术、工艺ISO9000的产生背景效益信息与软件工程学院8ISO9000发展历程标准起源与发展——1987——1994——2000(2000年12月18日颁布)信息与软件工程学院9ISO9000的特点•国际性:已成为各国对质量保证和质量管理制度的共同理解。•完整性:系列标准包含了术语、质量保证、质量管理到支持件技术标准及实施指南等一整套共计20个标准,形成了一个完整的体系结构。•兼容性:9001标准的内容最全面;9002标准排除了设计工作的质量要求,仅限于生产制造过程;9003标准仅限于检验和试验工作的质量要求。——〉范围依次渐窄。•主动性:选用和实施标准、建立质量体系的主体,是企业的主动行为。信息与软件工程学院10ISO9000的特点(二)•可信性:其认证是授权认证机构对供方质量体系进行的独立、公正的活动,因此,具有相当的说服力和可信度。•指导性:标准文本只是给出了质量管理和质量保证的原则,具体如何实施,需要供方结合自身机构的实际情况,特别是供方企业文化,进行创造性的解决。•科学性:是现代质量管理的科学原理。•实践性:具体表现在,标准文本不是空洞的条文,并基于大量的质量管理实践。如标准可向前追溯,得知其源于英国国家标准和美国军用标准等。信息与软件工程学院11ISO9000的适用范围•硬件:具有特定形状的产品,如机械、电子产品,包括计算机硬件。•软件:通过媒体表达的信息所构成的智力产品。包括计算机软件。•流程性材料:将原料转化为某一特定状态的产品。如,流体、粒状、线状等,通过瓶装、袋装等或通过管道传输交付。•服务:为满足客户需求的更为广泛的活动信息与软件工程学院12ISO9000的主导思想•强调质量并非在产品检验中得到,而是形成于生产的全过程。•为把握产品的质量,ISO9000要求“必须使影响产品质量的全部因素在生产全过程中始终处于受控状态”•要求证实:“企业具有持续提供符合要求产品的能力”。•强调“质量管理必须坚持进行质量改进”。信息与软件工程学院13ISO9000的主要内容ISO9000质量保证标准的选择和使用规定需方对供方质量体系的要求规定供方建立并实施质量体系的方法ISO9001设计~售后服务的质量保证模式ISO9002制造~安装的质量保证模式ISO9003最终检验和测试的质量保证模式ISO9004建立质量保证体系的指南硬件ISO9001、9002、9003均可直接适用软件ISO9003使得ISO9001适用于软件的指南售后服务ISO9004-2使得ISO9004适用于售后服务的指南软件的指南信息与软件工程学院14与软件相关的ISO9000标准标准名称说明ISO8402规定质量(质量、质量体系或检验等)有关的22个术语。目前,ISO/TC176正在进行修订,预计术语将增至67个,信息处理术语的定义引用自ISO2382-1ISODIS9000-4适用于“可靠性管理”的标准。它将对软件可靠性管理产生影响。这一标准的内容与国际电工委员会的IEC300-1相同(IEC300-1)ISO/IEC9126对ISO9000-3未具体示出的软件“质量特性”作出规定的标准。具体规定了功能性、可靠性、可使用性、效率、可维护性和可移植性等6个主特性和21个二级特性ISO13011-1对质量体系核查指南标准中的“检查步骤”作出规定软件开发全过程的管理作为按双边合同进行软件开发时规定从合同到开发及维护的“作业项目的意义与位置”的标准。ISO/IECJTC1正在审议软件配置管理有关软件“配置要素”的标准,用于管理软件的调试修改、多次更改等业务。对于生产与维护效率的提高非常重要。ISO/TC176和ISO/IECJTC1正在审议信息与软件工程学院15ISO9000-2000版的优点适用于各种组织、满足多个行业容易理解、结构简化减少了强制性的“程序”鼓励过程方法、操作性强强化关键:领导作用自我评价测量、突出持续改进与ISO14000具有更好的兼容性强调了顾客满意、考虑了相关方利益信息与软件工程学院16ISO9000-2000版的核心ISO9001:2000《质量管理体系要求》ISO9004:2000《质量管理体系业绩改进指南》信息与软件工程学院17ISO9000-2000版实施的八大原则一:以顾客为关注焦点二:领导作用三:全员参与四:过程方法五:管理的系统方法六:持续改进七:基于事实的决策方法八:互利的供方关系信息与软件工程学院18持续改进定义:增强满足要求的能力的循环活动——组织不断对质量管理体系各过程的改进识别过程确定过程过程的有效动作监控过程测量分析过程达到持续改进方法:审核发现、审核结论、数据分析、管理评审等,结果通常导致纠正措施或预防措施信息与软件工程学院19持续改进(二)管理职责资源管理测量分析及改进产品实现过程方法模式客户要求客户满意输出输入质量管理体系的持续改进产品CMMI国际标准信息与软件工程学院21CMM国际标准•CMM:CapabilityMaturityModel•CMMI:CapabilityMaturityModelIntegration,能力成熟度模型集成,CMM模型的最新版本•SW-CMM:针对软件的CMM•核心:把软件开发视为一个过程,并根据这一原则对软件开发和维护进行过程监控和研究,以使其更加科学化、标准化、使企业能够更好地实现商业目标。信息与软件工程学院22CMM的五级划分•初始级:基本没有健全的软件工程管理制度;每件事情都以特殊的方法来做•可重复级:有些基本的软件项目的管理行为,基于相似产品的经验。——必不可缺少的第一步•已定义级:已为软件生产过程编制了完整的文档。对管理和技术都有明确的定义,并按需要不断地改进过程,而且采用评审的办法来保证软件的质量•已管理级:对每个项目都设定质量和生产目标,并不断地测量;当偏离太多时,就采取行动来修正•优化级:连续地改进软件过程,提高生产率和质量信息与软件工程学院23ISO与CMM•ISO9000-3:解决质量体系的最小保证•CMM:-同样涉及质量和过程管理-明确强调持续的过程改进信息与软件工程学院24实施CMMI必须解决的认知问题•“唯管理论”:孤立地只抓过程改善,忽略了开发技术与人员的提高,过分强调管理的作用•缺乏真正了解技术的专家:如企业采用OO开发方法,虽然也采用RUP过程、ROSE等工具,但仅仅形似,没有得到OO方法的精髓•开发人员的积极性差,工作热情低,激励机制没有起到很好的作用信息与软件工程学院25正确的认知•管理就是预防:管理的作用是隐性的,不都能立竿见影,需要有耐心•坚持活学活用,以我为主:借鉴CMMI的精髓,逐步形成自己的风格,如微软的MSF、华为的管理模板•采用改良式:不期望通过一场运动解决所有过程能力的问题——过程改进就像减肥,减肥药短期见效,但若不从根本上改善习惯,体重将会很快恢复信息与软件工程学院26CMM小结CMMI不是万能的:只有CMMI是不行的,还要技术(开发方法、工具)、人员二个要素一起改善。软件文档风格信息与软件工程学院28文档风格的引入•软件的体系结构具有几种相对稳定的基本构架类型•软件系统分析师通常必须同时以3种方式对自己的软件进行考虑-作为一个实现单元集,是如何构造的;-作为一个具有运行时行为和交互作用的元素集,是如何构造的;-是如何在自己所处的环境内与非软件结构产生联系的。•软件文档的编制者,应该了解软件的这些基本构架类型会对软件文档的编制产生什么影响信息与软件工程学院29文档风格的概念因软件某一构架类型而影响软件文档的编制表达,称为软件文档风格信息与软件工程学院30文档风格的作用•允许将专门的设计知识应用于特定类型的软件系统,也允许利用特定风格的工具、分析方法和实现方案支持这类系统的设计•文档风格可以和软件的结构元素形成互动。可以采用与软件结构密切相关的视图及其类型一起讨论相关的软件文档编制•对软件文档风格的研究,既可以促进标准化,提高文档编制的效率和质量,又可以改进软件分析、构造和设计的过程,同时还支持软件文档编制和软件构架过程的同步与自动化信息与软件工程学院31软件文档的作用(回顾)•实现者的任务说明•系统的分析基础•自动代码生成规范•系统理解•投资回收•......信息与软件工程学院32软件视图•概念:是对一组系统元素及其关系的描述•不同的视图会在不同程度上表现出不同的质量属性。在系统开发过程中,最为关心的质量属性将影响编制文档视图。如,分层视图能反映系统的可移植性,部署实体可以推断系统的性能和可靠性等。•不同的视图也支持不同的目标和用途。应该首先明确文档的预期使用。因为不同的视图会突出不同的系统元素和(或)关系信息与软件工程学院33软件视图的类型•模块视图类型:能为系统主要实现单元编制文档服务•组件和连接器(C&C)视图类型:能为系统执行单元编制文档服务•分配视图类型:能为系统软件与其开发和执行环境之间的关系编制文档服务代表系统设计师必须考虑的3种视角:实现单元、运行时执行单元、从软件元素到环境结构的映射。而文档就是要记录这些内容信息与软件工程学院34模块视图类型•系统软件分解成可管理单元的方式仍然是重要的系统结构形式之一•建议:编制一个完整的软件文档时,应该至少采用一个模块视图类型的视图•文档风格:分解、使用、泛化、分层•每一种风格都能对基本模块视图类型进行限制信息与软件工程学院35例:四类风格ABCD分解管理DB管理(接口)DBDB查询(接口)用户使用ABCD泛化(继承)ABCD分层信息与软件工程学院36C&C视图类型•为系统执行单元编制文档服务•任何特定的组件或连接器都能以多重C&C视图的形式编制文档。例如,作为C/S系统中的服务器组件,也可作为数据储存库(共享存储)。•组件和连接器视图类型可通过许多风格得到特化。例如,粗粒度的早期设计决策被进一步精化后,就可能包含需要在以后得到精化的抽象连接器类型。信息与软件工程学院37例:C&C视图类型视图类型风格视图C&C管道与过滤器客户机-服务器……共享数据你的风格管道与过滤器视图共享数据视图你的视图信息与软件工程学院38分配视图类型•在软件系统开发过程中,硬件、文件系统和团队结构都会与软件系统的结构发生关系,进行交互。所以,也必须为这类交互编制相关文档•部署风格。描述组件和连接器(C&C)对硬件的映射,硬件是软件执行的场所。•实现风格。描述模块对包含它们的文件系统的映射•工作任务风格:描述模块与承担者的关系信息与软件工程学院39部署风格调度器服务器:主机databass会议数据库软件客户机:PC机Directchannel信息与软件工程学院40实现风格AmakesrcA.ccincludeA.hdocA.docconfigA.confAmake图例:具有模块名称的文件夹文件包容信息与软件工程学院41工作任务风格序号岗位人数职责1项目经理1项目整体规划、设计、管理;项目计划、总体设计等2需求分析2客户沟通,收集需求,确定应用原型;需求规格说明书3模块负责1手机端模块的设计、开发、管理;设计开发文档1服务器端模块的设计、开发、管理;设计开发文档1其他功能管理模块的设计、开发、管理;设计开发文档4接口与DB2
本文标题:IT工程师职业基础lecture-10
链接地址:https://www.777doc.com/doc-163779 .html