软件文档写作教程

第1章 绪论

1.1 软件文档的意义

1.2 软件文档的作用

1.3 软件文档的分类

1.4 软件文档必备的条件

1.5 软件文档的管理

本章小结

参考文献

第2章 软件文档的写作规范

2.1 项目立项阶段文档的写作规范

2.2 需求分析书的写作规范

2.3 概要设计书的写作规范

2.4 详细设计书的写作规范

2.5 项目结束阶段文档的写作规范

本章小结

参考文献

习题

第3章 软件项目立项阶段文档写作案例分析——某市轨道交通突发事件实时应急集成指挥系统案例分析

3.1 项目的目的和意义

3.2 国内外研究开发现状和发展趋势

3.3 项目现有工作基础

3.4 项目实施目标

3.5 主要研究开发内容

3.6 社会经济效益分析和风险分析

3.7 年度目标和年度实施计划

3.8 预期主要成果

本章小结

参考文献

习题

第4章 需求分析书案例分析一——研究生教务管理系统案例分析

4.1 引言

4.2 任务概述

4.3 需求规定

4.4 运行环境规定

本章小结

参考文献

习题

第5章 需求分析书案例分析二——奥运综合服务系统案例分析

5.1 系统概述

5.2 功能和非功能需求

5.3 数据需求

5.4 接口需求

5.5 环境需求

本章小结

参考文献

习题

第6章 需求分析书案例分析三——地铁综合信息查询系统案例分析

6.1 概述

6.2 系统需求

6.3 总体结构

6.4 用户培训

本章小结

参考文献

习题

第7章 概要设计书案例分析一——研究生教务管理系统案例分析

7.1 引言

7.2 总体设计

7.3 接口设计

7.4 运行设计

7.5 系统数据结构设计

7.6 系统出错处理设计

本章小结

参考文献

习题

第8章 概要设计书案例分析二——办公自动化系统案例分析

8.1 引言

8.2 概要设计

8.3 各子系统概要设计

8.4 接口设计

8.5 系统出错处理设计

本章小结

参考文献

习题

第9章 概要设计书案例分析三——某企业建筑业信息化系统案例分析

9.1 软件体系结构的确立

9.2 框架选型

9.3 软件开发模型选择

9.4 总体设计

9.5 数据库设计

本章小结

参考文献

习题

第10章 详细设计书案例分析一——研究生教务管理系统案例分析

10.1 引言

10.2 程序系统的结构

10.3 程序设计说明

10.4 算法

10.5 接口

10.6 存储分配

10.7 注释设计

10.8 限制条件

10.9 测试计划

本章小结

参考文献

习题

第11章 详细设计书案例分析二——中国教育信息化系统案例分析

11.1 案例分析

11.2 详细设计的工具

11.3 详细设计书的注意事项

11.4 详细设计的评审

本章小结

参考文献

习题

第12章 软件项目结束阶段文档写作案例分析——校园博客系统案例分析

12.1 测试概述

12.2 测试计划执行情况

12.3 测试总结

12.4 综合评价

本章小结

参考文献

习题

第13章 总结

不同于一般的软件文档写作教材，不仅讲述软件文档写作的基本内容和方法，而且根据软件工程领域的最新发展，结合典型开发案例，力求系统地描述可行性研究报告、项目建议书、招投标文件、需求分析书、概要设计书、详细设计书、项目验收报告和项目总结报告等文档的写作规范和技巧。以数个典型的软件系统开发项目为案例，重点讲述项目建议书，需求分析书、概要设计书、详细设计书和项目验收总结报告的内容、要求、写作技巧和注意事项，指导学生如何书写软件开发过程中的相关文档。《软件文档写作教程》可作为软件工程，计算机科学与技术等专业本科生及研究生的参考书，也可作为相关研究开发人员的参考书和工具书。