软件文档编写课程的课件.ppt

软件文档和标准,软件工程中心 钟晓峰2008-9,课程学习的目的：深入了解软件工程思想理解软件工程标准化的重要性掌握基本软件文档编写方法在实践中能够灵活使用软件标准，并根据项目实际需要对软件文档进行裁减,课程学习适用的对象：包括软件工程师、软件架构师、软件设计师、软件开发者、软件测试工作者、软件配置管理员、软件质量保证人员等从事软件工程相关活动工作人员。从事其它与文档有关的行业人员，如公司职员！,课程学习选用课本：软件开发 系统集成业 实战2000版 ISO9001标准,参考书目：软件编档导论 清华大学出版社 金波著 2008计算机软件工程国家标准汇编（共三卷）中国标准出版社 2007,重点讲授的内容：1）软件工程标准相关概念2）GB中关于软件工程相关标准介绍3）软件生存周期过程4）软件文档的编写5）软件文档的管理,为什么要编写软件文档？,你会编写软件文档吗？,软件文档的定义！,文档：某种数据媒体和其上所记录的数据。,软件文档：是一种重要的软件工程技术资料，产生于软件生存周期的整个过程，与计算机程序共同完成构成能完成特定功能的计算机软件。,软件包括哪些内容？,软件=程序+数据+文档,程序,程序,数据,文档,文档,软件,文档和程序一样重要：,1）软件文档是项目人员交互的桥梁软件开发人员、软件管理人员、软件测试人员、用户、软件销售人员2）是项目开发阶段工作程序和结束的标志3）是提高软件开发过程的透明度，是项目管理的依据4）是保证质量的重要依据5）是提供软件应用培训的资料6）是软件的历史档案,编制的软件文档往往面临很多问题：,语言表达不清楚、难以理解内容不完整描述了不该描述的内容内容不够细致文档格式不统一,软件文档的管理同样面临困难！,软件开发活动主要环节之间需保证的正确性,设计说明书,软件需求,需求规格说明书,源程序,运行结果,理解、设计、表达,理解、编码,输入、运行,理解、表达,?,没有规矩、不成方圆。,软件文档的标准化,程序的标准化,软件管理的标准化,软件质量保证的标准化,软件文档和标准之间的关系:,1、软件文档属于软件工程范畴,标准超出了软件工程,只有那些关于软件工程内使用的标准才属于软件工程范畴；2、软件工程标准包括了开发活动标准、产品技术标准、产品使用标准、产品服务标准、产品过程管理标准，软件文档一般产生在软件工程标准中规定的阶段产品；3、软件工程开发中的软件文档的编写必须直接或间接依据软件工程标准。,1、到目前为止学习了哪些软件工程课程？2、本人使用过的编程语言有哪些？3、到目前为止了解的软件开发模型有哪几种？4、有没有进行软件项目的实践，实践过程中写过哪些软件文档？4、你对软件工程的理解？5、你在院软件工程专业学习体会？,软件：计算机程序和计算机数据库。系统：由过程、硬件、软件、设施和人员组成的集合体，提供满足明确的要求或目标的能力。需方：从供方获得或采购系统、软件产品或软件服务的组织。开发方：在软件生存周期过程中执行开发活动的组织。维护方：执行维护活动的组织。操作方：运行系统的组织。软件产品：一组计算机程序、规程以及可能的相关文档和数据。用户：使用运行系统完成一项特定功能的个人和组织。-GB/T 8566-2007,