产品开发文件编写.pdfVIP

软件产品开发中各种文档的编写 2006 年01 月02 日 目 录 可行性研究报告》的编写提示 1 《 项目开发计划》的编写提示 5 《 软件需求说明书》的编写提示 7 《 数据要求说明书》的编写提示 9 《 概要设计说明书》的编写提示 11 《 详细设计说明书》的编写提示 13 《 数据库设计说明书》的编写提示 15 《 用户手册》的编写提示 17 《 操作手册》的编写提示 20 《 模块开发卷宗》的编写提示 22 《 测试计划》的编写提示 23 《 测试分析报告》的编写提示 25 《 开发进度月报》的编写提示 27 《 项目开发总结报告》的编写提示 29 《 文件编制实施规定的实例 31 可 行 性 研 究 报 告 1 引言 1.1 编写目的 说明编写本可行性研究报告的目的，指出预期的读者。 1.2 背景 说明：所建议开发的软件系统的名称；本项目的任务提出者、开发者、用户及实现 该软件的计算中心或计算机网络；该软件系统同其他系统或其他机构的基本的相互来往 关系。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出用得着的参考资料，如：本项目的经核准的计划任务书或合同、上级机关的批 文；属于本项目的其他已发表的文件；本文件中各处引用的文件、资料，包括所需用到 的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文 件资料的来源。 2 可行性研究的前提 说明对所建议的开发项目进行可行性研究的前提，如要求、目标、假定、限制等。 2.1 要求 说明对所建议开发的软件的基本要求，如：功能；性能；输出如报告、文件或数据， 对每项输出要说明其特征，如用途、产生频度、接口以及分发对象；输入说明系统的输 入，包括数据的来源、类型、数量、数据的组织以及提供的频度；处理流程和数据流程 用图表的方式表示出最基本的数据流程和处理流程，并辅之以叙述；在安全与保密方面 的要求；同本系统相连接的其他系统；完成期限。 2.2 目标 说明所建议系统的主要开发目标，如：人力与设备费用的减少；处理速度的提高； 控制精度或生产能力的提高；管理信息服务的改进；自动决策系统的改进；人员利用率 的改进。 2.3 条件、假定和限制 说明对这项开发中给出的条件、假定和所受到的限制，如：所建议系统的运行寿命 的最小值；进行系统方案选择比较的时间；经费、投资方面的来源和限制；法律和政策 方面的限制；硬件、软件、运行环境和开发环境方面的条件和限制；可利用的信息和资 源；系统投入使用的最晚时间。 2.4 进行可行性研究的方法 说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的。摘要说明所 使用的基本方法 和策略，如调查、加权、确定模型、建立基准点或仿真等。 2.5 评价尺度 说明对系统进行评价时所使用的主要尺度，如费用的多少、各项功能的优先次序、 开发时间的长短 及使用中的难易程度。 3 对现有系统的分析 这里的现有系统是指当前实际使用的系统，这个系统可能是计算机系统，也可能是 １ 一个机械系统甚 至是一个人工系统。 分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必 要性。 3.1 处理流程和数据流程 说明现有系统的基本的处理流程和数据流程。此流程可用图表即流程图的形式表 示，并加以叙述。 3.2 工作负荷 列出现有系统所承担的工作及工作量。 3.3 费用开支 列出由于运行现有系统所引起的费用开支，如人力、设备、空间、支持性服务、材 料等项开支以及开 支总额。 3.4 人员 列出为了现有系统的运行和维护所需要的人员