前言

众所周知，软件文档是整个软件开发工作的基础，现代工程化的软件开发离不开软件文档。软件文档体系的建立与软件开发阶段密切相关，是软件开发整个生命周期中必不可少的一部分，软件生命周期始于软件文档，软件文档贯穿着整个软件生命周期。

作者从事软件工程的教学和研究已有数年的历史，从长期的工作经验中发现，无论是相关专业的学生还是研究开发人员，对软件文档的写作都越来越重视，同时对软件文档写作的写作规范缺乏相应的基础，国内有关软件文档写作的教材也比较少，而且缺乏实际案例的分析。软件文档写作是一门实践性比较强的课程，必须结合实际的软件开发案例进行教学。我们在总结多年的教学和研究经验的基础上，参考国内外最新版本的教材和论文，结合作者多年来跟踪国际上相关领域的最新研发方向的成果编写了这本书。

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

本书包括以下13章。

第1章是绪论。主要介绍软件文档的意义、作用和分类等相关知识。

第2章介绍软件文档的写作规范。其主要内容包括可行性研究报告、项目建议书、招投标文件的写作规范，需求分析书写作规范，概要设计书写作规范，详细设计书写作规范，项目验收总结报告写作规范。

第3章通过典型案例—某市轨道交通突发事件实时应急集成指挥系统开发过程中的软件文档，讲述软件项目立项阶段项目建议书的内容、要求、写作技巧和注意事项。

第4章通过典型案例—研究生教务管理系统开发过程中的软件文档，讲述需求分析书的内容、要求、写作技巧和注意事项。

第5章通过典型案例—奥运综合服务系统开发过程中的软件文档，进一步讲述需求分析书的内容、要求、写作技巧和注意事项。

第6章通过典型案例—地铁综合信息查询系统开发过程中的软件文档，讲述企业实际项目的需求设计书的内容、要求、写作技巧和注意事项。

第7章通过典型案例—研究生教务管理系统开发过程中的软件文档，讲述概要设计书的内容、要求、写作技巧和注意事项。

第8章通过典型案例—办公自动化系统开发过程中的软件文档，进一步讲述概要设计书的内容、要求、写作技巧和注意事项。

第9章通过典型案例—某企业建筑业信息化系统开发过程中的软件文档，讲述企业实际项目的概要设计书的内容、要求、写作技巧和注意事项。

第10章通过典型案例—研究生教务管理系统开发过程中的软件文档，讲述详细设计书的内容、要求、写作技巧和注意事项。

第11章通过典型案例—中国教育信息化系统开发过程中的软件文档，讲述企业实际项目的详细设计书的内容、要求、写作技巧和注意事项。

第12章通过典型案例—校园博客系统开发过程中的软件文档，讲述软件项目结束阶段项目验收总结报告的内容、要求、写作技巧和注意事项。

第13章总结了本书的主要内容。

本书在浅显易懂的理论介绍之后，将重点放在典型案例分析上，通过具体形象的案例去理解有关理论。本书可作为软件工程，计算机科学与技术等专业本科生及研究生的参考书，也可作为相关研究开发人员的参考书和工具书。

由于笔者学识有限，本书难免有不足之处，恳请各位专家读者不吝赐教。