软件文档写作-第6讲开发文档(完整)

第六讲 软件开发文档

1

6.1 开发文档概述

开发文档是描述软件开发过程及内容的文档，包括软件需求、 软件设计、软件实现、软件测试、软件质量保证等各种文档。 开发文档也包括软件的详细设计描述(程序逻辑、程序间相互关 系、数据格式和存储等)

软件开发文档的作用：

记录生成软件需求、设计、编码和测试的详细规定和说明，是软件开发过 程所有阶段之间的通信工具； 描述开发小组的职责。通过规定开发过程的角色，来定义做什么、如何做 和何时做； 用作检验点且允许管理者评定开发进度和质量； 形成维护人员所要求的基本的软件支持文档；

记录软件开发的历史。

2

基本的软件开发文档主要有：

可行性研究和项目任务书

需求规格说明 功能规格说明 设计规格说明，包括程序和数据规格说明 开发计划

软件集成和测试计划

质量保证计划、标准、进度 安全和测试信息

3

6.2 可行性研究报告

在软件开发的第一阶段，需要完成的可行性研究与项目计划任务，其 主要工作是了解用户需求和现实环境，研究并论证项目的可行性，提出 系统方案，制定初步的项目开发计划。可行性研究报告是这一阶段工作 成果的主要标志之一。 在《计算机软件产品开发文档编制指南》中指出，可行性研究报告的 编制目的是：“说明该软件开发项目的实现在技术上、经济上和社会条 件上的可行性；评述为合理地达到目标可能选择的各种方案；说明并论 证所选定的方案。” 1. 可行性研究报告的内容 对于确定的问题，判定能否解决，是否值得解决，是可行性研究的根 本任务。因此，可以按以下内容组织可行性研究报告：

(1) 陈述开发目的、要求和限制条件，表达可行性研究的前提条件。 (2) 对现有系统的描述，进而阐述系统开发的意义和必要性。 (3) 提出若干新系统的建议方案，并依次进行技术、经济和社会可行性分析 (4) 在比较多个方案的基础上，得出可行性研究的结论。

4

2. 可行性研究报告的要求 软件的开发首先要确切定义用户要求解决的问题，即确定要解 决问题的性质、目标和规模。对此，可行性分析人员对所要解决 问题的理解是否正确十分关键，因为这决定了开发工作的方向。 具体，可行性研究报告的要求如下： (1) 阐明目标软件的基本要求

功能

性能

输出(如报告、文档或数据，输出项特征，如用途、产生频度、接口及方 法对象) 输入(包括数据来源、类型、数量、数据的组织以及提供的频度) 处理流程和数据流程(用图表表示最基本的部分，并辅之以文字说明) 安全和保密方

本文来源：https://www.bwwdw.com/article/rf6i.html