普通高等教育"十一五"国家级规划教材

章节摘录

　　虽然软件工程生存周期规定每一阶段都要生成高质量的文档，但人们常常认为软件就是程序而不是文档。这是很多人对软件的一种误解，这种误解有其根深蒂固的生长土壤。人们确实将软件看成是一种产品，它们具有与其他产品一样的共性。但是，与其他产品相比，软件毕竟是一种逻辑的而不是物理的系统成分。软件开发不像加工一个机械零件那样看得见、摸得着。由于不存在物理上的损伤和磨损用坏等问题，所以在软件的开发过程中，人们往往不易或不愿意像开发机器产品、建造房屋那样有计划、有步骤、按规范进行。直至现在，还常常有人喜欢按照自己的一套来“编程序”，拿到一个软件开发项目后，在没有搞好需求分析、结构设计等工作的情况下，就急急忙忙动手编写代码。表面看来，这是赶进度，节省了时间，但欲速则不达。由于急于求成，编写程序时也往往忽略好的编码风格，这些都给以后的软件开发和维护工作带来潜在的隐患和很大的困难，也许过了一段时间才会意识到，但为时已晚。应该说，这只是在写程序（即代码），而不是在开发软件。对于这样的人，我们宁愿称其为程序工人而非软件工程师。软件发展历史上的“力拔山兮气盖世”的个人英雄主义时代已经过去。毋庸讳言，单枪匹马、自以为是、孤芳自赏的作坊式作风仍然是制约我国软件产业发展的严重问题。　　软件开发是一个把用户需要转化为软件需求，把软件需求转化为软件设计，用软件代码来实现软件设计，对软件代码进行测试，交付并投入运行的过程。在这个过程中的每一阶段，都应该包含有相应的文档编制工作。在建造一幢大楼时，各种各样的相关的设计和施工图纸贯穿于大楼建造的始终。我们很难想象，如果没有这些设计图和施工图，高质量的楼宇如何能拔地而起。同理，在软件开发过程中，没有充分的分析、合理的设计、实现，这样开发出的软件产品必然经不起实际的考验。常常有人认为，软件项目成功的标志是交出能够正确运行的程序，文档是可有可无的，如果一定要写，也只是在程序本身完成之后再补上。这种仅仅为了交差才补写的文档往往和实际开发的程序存在很大差距，难以发挥其应有的作用。符合要求的、规范化的文档在软件开发中的作用就如同零件图纸在产品开发中的作用一样，是表达思想、传递信息的重要途径，是保证软件开发质量、提高软件可维护性、可靠性和可生产性的重要措施。　　因此，软件绝不是程序的同义词。软件是与计算机系统的操作有关的程序及文档的集合。　　文档的编写是软件开发过程中的重要工作，是工程化方法的重要体现。具体说来，软件文档具有以下几方面的作用。

前言

　　软件开发是一个把用户需要转化为软件需求，把软件需求转化为软件设计，用软件代码来实现软件设计，对软件代码进行测试，交付并投入运行的过程。在这个过程中的每一阶段，都需要编写相应的文档。文档的编写是软件开发过程中的重要工作，是工程化方法的重要体现.符合要求的、规范化的文档在软件开发中起着表达思想、传递信息的重要作用，是保证软件开发质量、提高软件可维护性、可靠性和可生产性的重要措施。　　本书遵循国家和国际有关计算机软件开发文档编制的标准和规范，从基于结构化方法和面向对象方法两个方面，从应用的角度，详细地探讨了软件开发过程中《可行性研究报告》、《软件需求规格说明书》、《概要设计说明书》和《详细设计说明书》等几个重要文档的编写要求与方法，强调了CASE工具在文档编写过程中的作用，并给出基于CASE工具支持的文档编写实例。　　我们特别强调，“软件文档编写”本质上是一门实践性很强的课程。使用本书作为教材时，课堂教学和实验环节参考学时分配如下表所示。

书籍目录

第1章 软件工程标准化与软件文档1.1 软件生存周期与软件文档1.2 软件文档的作用1.3 软件文档分类1.3.1 开发文档1.3.2 产品文档1.3.3 管理文档1.4 软件工程标准化1.4.1 软件工程标准化的意义1.4.2 软件工程标准的层次1.4.3 中国的软件标准1.4.4 五种常见的国际软件标准1.5 软件文档编写要求1.5.1 软件文档的编写原则1.5.2 文档编写的灵活性1.5.3 制定文档编写策略1.5.4 建立企业的文档标准1.5.5 制订文档编写计划1.5.6 建立文档管理规程1.5.7 软件文档的质量要求1.6 项目开发的文档化本章小结习題第2章 CASE工具与软件文档编写2.1 CAsE概述2.2 CAsE支持下的软件建模和文档编写工具2.2.1 ProccssAnalYst和DataArchitcCt2.2.2 SoDA自动化文档设计和生成2.2.3 P!ayCASE本章小结习题第3章 可行性研究报告3.1 可行性研究概述3.1.1 可行性研究的任务3.1.2 可行性研究的步骤3.2 可行性研究报告的内容要求与编写指南3.2.1 可行性研究报告的引言3.2.2 可行性研究的前提3.2.3 对现有系统的分析3.2.4 对所建议系统的分析3.2.5 可行性分析3.2.6 可行性分析结论3.3 可行性研究报告编写示例本章小节习題实训第4章 基于结构化方法的软件文档4.1 软件需求規格说明书4.1.1 需求分析概述4.1.2 软件需求规格说明书的目的和编写要求4.1.3 软件需求规格说明书的内容要求与编写指南4.1.4 软件需求规格说明书示例4.2 概要设计说明书4.2.1 概要设计概述4.2.2 概要设计说明书的内容要求与编写指南4.2.3 概要设计说明书示例4.3 详细设计说明书4.3.1 详细设计概述4.3.2 详细设计说明书的内容要求和编写指南4.3.3 详细设计说明书示例本章小结习题实训第5章 基于面向对象方法的软件需求规格说明书5.1 面向对象的软件需求分析概述5.2 软件需求規格说明书的内容要求与编写指南5.2.1 引言5.2.2 项目概述5.2.3 需求规定5.3 用例说明书的内容及编写要点5.4 基于面向对象方法的软件需求規格说明书示例本章小结习題实训第6章 基于面向对象方法的软件设计说明书6.1 面向对象软件设计概述6.2 面向对象的软件设计说明书的内容要求和编写指南6.2.1 类报告6.2.2 用例实现报告6.2.3 设计模型报告6.3 面向对象设计文档的编写示例本章小结实训第7章 程序代码的文档化7.1 程序代码規范7.2 Doxygen应用基础7.2.1 安装Doxygen7.2.2 设置项目的Doxygen配置文件模板7.2 ‘3编写正确格式的注释7.2.4 制作说明文件7.2.5 Doxygen使用步骤及范例本章小结习题实训第8章 面向对象测试文档8.1 面向对象测试概述8.1.1 面向对象测试的具体任务8.1.2 面向对象测试的步骤8.2 面向对象测试文档8.2.1 测试计划8.2.2 测试用例8.2.3 测试报告8.3 面向对象测试文档的内容要求和编写指南8.3.1 引言8.3.2 项目背景8.3.3 质量目标8.3.4 测试资源8.3.5 测试策略8.3.6 测试计划本章小结习題实训参考文献

编辑推荐

　 其他版本请见：《普通高等教育“十一五”国家级规划教材：软件文档编写》

作者简介

《普通高等教育"十一五"国家级规划教材:软件文档写作》是普通高等教育“十一五”国家级规划教村。《普通高等教育"十一五"国家级规划教材:软件文档写作》遵循国家有关计算机软件开发文档编制的标准和规范，从基于结构化方法和面向对象方法两个方面，介纠了可行性研究报告、软件需求规格说明书、概要设计说明书、详细设计说明书、软件测试说明书等几个重要的软件开发文档的编写要求与方法，强调了CASE工具在文档编写过程中的作用，并给出了软件文档编写的详细实例。

---

 普通高等教育"十一五"国家级规划教材下载

---