软件文档写作

　　《软件文档写作》遵循国家有关计算机软件开发文档编制的标准和规范，从基于结构化方法和面向对象方法两个方面，介绍了可行性研究报告、软件需求规格说明书、概要设计说明书、详细设计说明书、软件测试说明书等几个重要的软件开发文档的编写要求与方法，强调了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和DataArchitcCt
2.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 安装Doxygen
7.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 测试计划
本章小结
习題
实训
参考文献