小型软件所需的五种文档

软件需求与开发计划

第一章 引 言

  说明待开发系统的名称、项目委托单位、项目承办单位或软件开发单位、用户,列出本计划中用到的专门术语和外文首字母词组的定义,列出要用到的参考资料。

第二章 任务概述

  说明该软件开发的应用目标和作用范围。软件用户特点以及开发工作所受到的假定和约束,说明软件开发内容。主要参加人员、产品和验收标准。

第三章 需求规定

  说明该软件的功能和性能要求、输入输出要求、运行环境要求、数据管理能力、故障处理以及其它专门要求。

第四章 实施计划

  说明工作任务分解与人员分工,进度要求、预算及关键问题。

第五章 支持条件

  说明软件开发所需的各种条件,需要由用户承担的工作或需由其他单位提供的条件。

软件设计说明书

第一章 引 言

  说明待开发系统的名称、项目委托单位、项目承办单位或软件开发单位、用户。列出本计划中用到的专门术语和外文首字母词组的定义,列出要用到的参考资料。

第二章 系统设计

  说明该软件应满足的功能、性能要求,运行环境,系统的组织结构;用图表列出系统内每个程序的名称、标识符及其层次关系。

第三章 接口设计

  说明该软件同外界的所有接口,包括人机界面、软硬件之间接口、与支持软件之间的接口,并说明系统内各部分之间的接口。

第四章 运行设计

  说明不同的运行控制所引起的不同的运行过程。

第五章 数据结构设计

  说明系统内每个数据结构的设计要点以及各数据结构与各程序的对应关系。

第六章 出错处理设计

  说明系统的容错性设计,给出出错信息一览表,列举故障出现后可能采取的补救措施。

使用说明书

第一章 引 言

  说明待开发系统的名称、项目委托单位、项目承办单位或软件开发单位、用户。列出本计划中用到的专门术语和外文首字母词组的定义,列出要用到的参考资料。

第二章 用 途

  说明该软件系统的功能、性能和安全保密方面的内容。

第三章 运行环境

  说明运行该软件系统所需要的计算机硬件、支撑软件和数据环境。

第四章 使用过程

  说明该软件系统的使用过程和操作方法,包括安装与初始化。数据的输入与输出、文件查询和终端操作。

测试分析报告

第一章 引 言

  说明待开发系统的名称、项目委托单位、项目承办单位或软件开发单位、用户。列出本计划中用到的专门术语和外文首字母词组的定义,列出要用到的参考资料。

第二章 测试概要

  列出每项测试的标识符及测试内容,并指出实际进行的测试工作内容与测试中预先设计的内容之间的差别及原因。

第三章 测试结果及发现

  逐项列出每一测试项在测试中的实际动态输出结果与需求分析中对动态输出的要求进行比较,陈述其中的发现。

第四章 对软件功能的结论

  列出所开发系统的功能,包括经测试证实的能力和查出的缺陷和局限性。

第五章 分析摘要

  描述经测试证实了的该软件的能力,分析尚存缺陷及限制对软件性能的影响,对每项缺陷提出改进建议,并评价该软件是否已达到预定目标,能否交付使用。

第六章 测试消耗资源

  总结测试工作的资源消耗数据,如工作人员的水平级别、机时消耗等。

项目开发总结

第一章 引 言

  说明待开发系统的名称、项目委托单位、项目承办单位或软件开发单位、用户。列出本计划中用到的专门术语和外文首字母词组的定义,列出要用到的参考资料。

第二章 实际开发结果

  说明实际开发软件产品的主要功能和性能、计划进度与实际进度、经费预算与实际开支、计划工时与实耗工时。

第三章 开发工作评价

  给出对生产效率、产品质量、技术方法的评价,分析开发中出现错误的原因。

第四章 经验与教训

  总结在该项开发工作中取得的主要经验与教训。