前言
软件文档是软件的重要组成部分，在软件管理人员、开发人员、测试人员、维护人员、用户之间发挥着重要的沟通桥梁作用，同时使不可见的软件变得可视和可控。软件项目管理文档能够展示软件开发的预期目标和为达成目标采取的措施及成效，软件需求、设计及测试文档则记录了软件分析、设计实现和验证的具体技术细节，软件使用文档是交付用户时不可缺少的使用说明。可见，文档编写贯穿于软件开发的整个生命周期，在软件开发活动中占有突出的地位和相当的工作量，高质量的软件文档是软件开发项目成功的有力支撑。同时，软件文档是软件开发组织的重要资产，记录了软件开发过程中的全部信息，对于提高组织的软件开发能力也具有积极作用。
本书是“软件开发与测试丛书”中的一册，定位于指导软件开发与测试文档编写的实用指南，在文档类型选择、内容要求上都与基于CMMI的软件工程实施、软件质量管理、软件测试管理有呼应和体现，是相关要求在文档编写上的具体呈现。
本书以大型软件开发常用开发过程为例，参考相关标准规范要求，系统地介绍了软件需求文档、软件设计文档、软件测试文档、软件使用文档和软件项目管理文档5大类20种文档的编写要求，给出了文档内容模板和部分文档内容的具体示例，并总结了常见的文档编写问题。本书旨在帮助软件从业人员提升对软件文档重要性的认识，提高软件文档的编写质量，针对性和实用性较强。本书既可供需要进行软件文档编写的工程实践人员参考，也可供相关单位进行标准化推广和质量管理体系建设工作借鉴。
本书共有21章，分为六篇。第一篇（第1章）基础篇，简要介绍了常用软件开发过程——W模型的主要过程活动及其产生的相关文档的种类、作用、裁剪准则和有关文档标准等。第二篇到第六篇分别详细介绍了软件需求类、设计类、测试类、项目管理类和使用类共20种具体文档的编写要求和内容模板，每种文档都给出部分具体内容的示例，并指出编写中常见的问题。其中，第二篇（第2～5章）软件需求文档，介绍了系统规格说明、软件研制任务书、软件需求规格说明、接口需求规格说明4种需求文档；第三篇（第6～10章）软件设计文档，分别介绍了系统设计说明、接口设计说明、数据库设计说明、软件概要设计说明、软件详细设计说明5种设计文档；第四篇（第11～14章）软件测试文档，分别介绍了软件测试计划、软件测试说明、软件测试报告、软件回归测试方案4种测试文档；第五篇（第15～17章）软件使用文档，分别介绍了软件产品规格说明、软件版本说明、软件用户手册3种软件使用文档；第六篇（第18～21章）软件项目管理文档，分别介绍软件开发计划、软件配置管理计划、软件质量保证计划、软件研制总结报告4种软件项目管理文档。
本书第1章、11～13章、18、19章由刘文红编写，第2～5章由张卫祥编写，第6～10章由董锐编写，第14、20、21章由陈青编写，第15～17章由马贤颖编写。全书由刘文红负责策划、组织、整理和统稿。衷心感谢赵辉、杜会森、鲍忠贵、张卫民、杨宝明、牛胜芬等专家以及清华大学出版社在编写过程中给予的大力支持和帮助。由于理论和实践水平有限，书中难免有错误和不妥之处，敬请读者批评指正。
编者 2019年2月
