文档的作用和分类

• 概要设计说明书：该说 明书是概要设计阶段的工作 成果，它应说明功能分配、模 块划分、程序的总体结构、输 入输出以及接口设计、运行设 计、数据结构设计和出错处理 设计等，为详细设计奠定基 础。
• 详细设计说明书：着重 描述每一模块是怎样实现的， 包括实现算法、逻辑流程等。 ?用户手册：本手册详细 描述软件的功能、性能和用户 界面，使用户了解如何使用该软件。
  
  

  文档		用户文档		用户手册
  				操作手册
  				维护修改建议
  				软件需求（规格）说明书
  		开发文档		软件需求（规格）说明书
  				数据要求说明书
  				概要设计说明书
  				详细设计说明书
  				可行性研究报告
  				项目开发计划
  		管理文档		项目开发计划
  				测试计划
  				测试报告
  				开发进度月报
  				开发总结报告

  字串1

  
  图9.3 三种文档
  
  
• 操作手册：本手册为操作人员提供该软件各种运行情况的 有关知识，特别是操作方法的具体细节。
• 测试计划：为做好组装测试和确认测试，需为如何组织测试 制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用 例的选取原则、测试结果允许的偏差范围等。
• 测试分析报告：测试工作完成以后，应提交测试计划执行 情况的说明。对测试结果加以分析，并提出测试的结论意见。
• 开发进度月报：该月报系软件人员按月向管理部门提交的 项目进展情况报告。报告应包括进度计划与实际执行情况的比较、 阶段成果、遇到的问题和解决的办法以及下个月的打算等。
• 项目开发总结报告：软件项目开发完成以后，应与项目实 施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本 和投入的人力。此外还需对开发工作作出评价，总结出经验和教 训。
• 维护修改建议，软件产品投入运行以后，发现了需对其进 行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影 响估计作详细的描述，写成维护修改建议，提交审批。 以上这些文档是在软件生存期中，随着各阶段工作的开展适 时编制。其中有的仅反映一个阶段的工作，有的则需跨越多个阶 段。表5给出了各个文档应在软件生存期中哪个阶段编写。这 些文档最终要向软件管理部门，或是向用户回答以下的问题：
  字串9
  
  表9.2 软件生存期各阶段编制的文档

  阶段 字串1 文档 字串4	可行性药酒与计划	需求分析	设计	代码编写	测试	运行与维护
  可行性研究报告
  项目开发计划
  软件需求说明
  数据要求说明
  概要设计说明
  星系设计说明
  测试计划
  用户手册
  操作手册
  测试分析报告
  开发进度月报
  项目开发总结
  维护修改建议

  字串1

  
  
  
• 哪些需求要被满足，即回答“做什么?”
• 所开发的软件在什么环境中实现以及所需信息从哪里来， 即回答“从何处?”
• 某些开发工作的时间如何安排，即回答“何时干?”
• 某些开发(或维护)工作打算由“谁来干?”
• 某些需求是怎么实现的?
• 为什么要进行那些软件开发或维护修改工作?

上述十三个文档都在一定程度上回答了这六个方面的问题。这可从表中看到。 字串4

表9.3 文档所回答的问题 字串9

至此，我们对文档的作用有了进一步的理解。每一个文档的任 务也是明确的，任何一个文档都此是多余的。 字串3