软件文档编写.doc

软件文档编写

目录

第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.1CAsE概述

2.2CAsE支持下的软件建模和文档编写工具

2.2.1ProccssAnalYst和DataArchitcCt

2.2.2SoDA自动化文档设计和生成

2.2.3PlayCASE

本章小结

习题

第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可行性研究报告编写示例

本章小节

习題

实训1

第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详细设计说明书示例

本章小结

习题

实训2

第5章基于面向对象方法的软件需求规格说明书

5.1面向对象的软件需求分析概述

5.2软件需求規格说明书的内容要求与编写指南

5.2.1引言

5.2.2项目概述

5.2.3需求规定

5.3用例说明书的内容及编写要点

5.4基于面向对象方法的软件需求規格说明书示例

本章小结

习題

实训3

第6章基于面向对象方法的软件设计说明书

6.1面向对象软件设计概述

6.2面向对象的软件设计说明书的内容要求和编写指南

6.2.1类报告

6.2.2用例实现报告

6.2.3设计模型报告

6.3面向对象设计文档的编写示例

本章小结

实训4

第7章程序代码的文档化

7.1程序代码規范

7.2Doxygen应用基础

7.2.1安装Doxygen

7.2.2设置项目的Doxygen配置文件模板

7.2.3编写正确格式的注释

7.2.4制作说明文件

7.2.5Doxygen使用步骤及范例

本章小结

习题

实训5

第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测试计划

本章小结

习題

实训6

参考文献

第1章

软件工程标准化与软件文档

学习目标

软件生存周期与软件文档。

软件文档的作用与分类。

软件工程标准化的意义和作用。

软件工程标准的分类方法，软件工程标准的制定与推行过程。

我国的软件工程标准化工作和相关标准。

软件是指与计算机系统的操作有关的计算机程序及文档的集合。简单地说,软件包括程序和文档两部分。计算机程序是指适合于计算机处理的指令序列以及所处理的数据：软件文档（softwaredocument）是与软件开发、维护和使用有关的文字材料,如技术文档、设计文档、版本说明文档等，文档和程序共同构成了能完成特定功能的计算机软件。可以说，没有文档的软件，不能称其为软件，更不能成为软件产品。

1.1软件生存周期与软件文档

软件生存周期由计划、开发和运行三个时期组成,每一时期可再细分一些工作阶段。文档是与软件生存周期紧密关联的。

计划时期

可以把计划时期再细分为几个阶段:

（1）问题定义

（2）