前言

软件文档随着软件的产生而产生，随着软件工程的提出和发展而不断得到规范，并且软件文档也成为软件工程各个阶段里程碑的重要标志之一。但在实际软件开发过程中，由于人为因素以及时间和成本的限制，导致软件文档资料通常既不完整也不合格，进而对软件开发和后期维护造成影响。

　　本书旨在将软件工程的基础理论、实践和文档写作紧密结合，以提供一个统一分层的软件文档写作体系； 将有关软件工程理论、软件文档写作方法的叙述、分析和应用有机地结合，使之形成一个较完整的软件文档写作方法体系； 对软件文档管理给予系统的介绍，从而充实和丰富传统的软件文档写作。

　　本书是作者十多年来从事软件工程教学、理论与实践研究的学习心得和工作总结，且汇入了一些企业的软件文档规范和阅读国内外大量相关著作和论文的体会。它以分析的观点、实践的角度，站在开发与应用的立场来进行讨论，希望不仅说明软件文档“是什么”，还进一步分析“为什么”，且讨论“如何做”，使读者不仅能“知其然”，还能“知其所以然”，懂得“如何应用”。它不仅包括了软件工程各个阶段的文档，还从质量保证和配置管理的角度说明对文档的管理。

　　全书共分10章，第1章介绍软件工程基础以及软件文档和软件过程之间的关系； 第2章介绍项目规划类文档写作，包括商业计划书、可行性研究报告、项目方案书和项目开发计划等； 第3章介绍需求类文档写作，主要涉及需求规格说明书； 第4章介绍设计类文档写作，包括架构文档、概要设计说明书、详细设计说明书、数据库设计说明书和界面设计文档等； 第5章介绍测试类文档写作，包括测试用例、测试计划和测试分析报告； 第6章介绍项目结束类文档，包括用户培训计划、用户手册、产品手册和项目总结报告等； 第7章介绍项目管理过程类文档，包括项目风险管理、时间进度管理、估算管理和项目的月报与周报等； 第8章介绍质量保证相关文档； 第9章介绍软件文档配置管理的方案，对软件文档进行版本控制； 第10章介绍企业软件文档的管理； 最后是附录，给出了若干软件文档的模板供读者参考。

　　本书在编写过程中力求语言通俗易懂，文字简洁明了，便于自学者阅读，除可作为高校计算机专业和软件工程专业的教材外，也可供从事计算机工作的工程技术人员及其他自学者参考。

　　本书的手稿已在软件学院对本科生和研究生讲授了多次，他们有的阅读了原讲义，并提出过意见。

　　对于书中的许多内容，作者的多届研究生、本科生曾从各个不同的方面、以不同的形式做了许多工作。在此，一并向他们表示诚挚的谢意。

　　诚如前面所说，书中的许多方面是作者的学习与实践体会，有的内容是作者的研究心得，再加之作者才学疏浅，水平与能力有限，因此书中见仁见智之说、不妥或不足之处，恐在所难免，切盼学术界同仁、软件从业人员和各方读者不吝赐教。

作者

2016年8月