软件工程开发文档写作教程(05)

一个软件项目从立项到结尾共有几个阶段：立项，需求分析，概要设计，详细设计，软件编码，软件测试，维护，验收。在这几个阶段中，每一个阶段都有各自的文档内容及格式，但是国内目前存在以下一些现状： 1 .文档极其简单，相当于没有文档。 2 .文档流于形式，没有什么实际的价值。 3 .太强调文档的重要性，以至于文档不能改，只能改代码。

软件项目在立项阶段需要进行市场调查和产品定位等的业务分析，并且形成规范的可行性研究报告、项目建议书和投标文件，论述开发软件产品的充分理由。

接下来，我们介绍立项阶段的三个文档的写作规范：

可行性研究报告的编写目的是说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能选择的各种方案；说明并论证所选定的方案。

1.1 编写目的 说明编写本可行性研究报告的目的，指出预期的读者。 1.2 背景 说明： a.所建议开发的软件系统的名称。 b.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c.该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出可以使用的参考资料，如: a.本项目的经核准的计划任务书或合同、上级机关的批文。 b.属于本项目的其他已发表的文件。 c.本文件中各处引用的文件、资料，包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

说明对所建议的开发项目进行可行性研究的前提，如要求、目标、假定、限制等。 2.1 要求 说明对所建议开发的软件的基本要求，如： a.功能。 b.性能。 c.输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。 d.输入说明系统的输入，包括数据的来源、类型、数量、数据的组织以及提供的频度。 e.处理流程和数据流程，用图表的方式表示出最基本的数据流程和处理流程，并辅之以叙述。 f.安全与保密方面的要求。 g.同本系统相连接的其他系统。 h.完成期限。 2.2 目标 说明所建议系统的主要开发目标，如： a.人力与设备费用的减少。 b.处理速度的提高。 c.控制精度或生产能力的提高• d.管理信息服务的改进。 e.自动决策系统的改进。 f.人员利用率的改进。 2.3 条件、假定和限制 说明对这项开发中给出的条件、假定和所受到的限制，如： a.所建议系统的运行寿命的最小值。 b.进行系统方案选择比较的时间。 c.经费、投资方面的来源和限制。 d.法律和政策方面的限制。 e.硬件、软件、运行环境和开发环境方面的条件和限制。 f.可利用的信息和资源。 g.系统投入使用的最晚时间。 2.4 进行可行性研究的方法 说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的。摘要说明所使用的基本方法和策略，如调查、加权、确定模型、建立基准点或仿真等。 2.5 评价尺度 说明对系统进行评价时所使用的主要尺度，如费用的多少、各项功能的优先次序、开发时间的长短及使用中的难易程度。

这里的现有系统是指当前实际使用的系统，这个系统可能是计算机系统，也可能是一个机械系统甚至是一个人工系统。分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。 3.1 处理流程和数据流程 说明现有系统的基本的处理流程和数据流程。此流程可用图表即流程图的形式表示，并加以叙述。 3.2 工作负荷 列出现有系统所承担的工作及工作量。 3.3 费用开支 列出由于运行现有系统所引起的费用开支，如人力、设备、空间、支持性服务、材料等项开支以及开支总额。 3.4 人员 列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。 3.5 设备 列出现有系统所使用的各种设备。 3.6 局限性 列出本系统的主要的局限性，例如处理时间赶不上需要，响应不及时，数据存储能力不足，处理功能不够等。并且要说明为什么对现有系统的改进性维护已经不能解决问题。

本部分将用来说明所建议系统的目标和要求将如何被满足。 4.1 对所建议系统的说明 概括地说明所建议系统，并说明列出的要求将如何得到满足，说明所使用的基本方法及理论根据。 4.2 处理流程和数据流程 给出所建议系统的处理流程和数据流程。 4.3 改进之处 按2.2条中列出的目标，逐项说明所建议系统相对于现存系统具有的改进。 4.4 影响 说明在建立所建议系统时，预期将带来的影响，包括： 4.4.1 对设备的影响 说明新提出的设备要求及对现存系统中尚可使用的设备须做出的修改。 4.4.2 对软件的影响 说明为了使现存的应用软件和支持软件能够同所建议系统相适应。而需要对这些软件所进行的修改和补充。 4.4.3 对用户单位机构的影响 说明为了建立和运行所建议系统，对用户单位机构、人员的数量和技术水平等方面的全部要求。 4.4.4 对系统运行过程的影响 说明所建议系统对运行过程的影响，如： a.用户的操作规程。 b.运行中心的操作规程。 c.运行中心与用户之间的关系。 d.源数据的处理。 e.数据进入系统的过程. f.对数据保存的要求，对数据存储、恢复的处理。 g.输出报告的处理过程、存储媒体和调度方法。 h.系统失效的后果及恢复的处理办法。 4.4.5 对开发的影响 说明对开发的影响，如： a.为了支持所建议系统的开发，用户需进行的工作。 b.为了建立一个数据库所栗求的数据资源。 c.为了开发和测验所建议系统而需要的计算机资源。 d.所涉及的保密与安全问题。 4.4.6 对地点和设施的影响. 说明对建筑物改造的要求及对环境设施的要求。 4.4.7 对经费开支的影响 扼要说明为了所建议系统的开发，设计和维持运行而需要的各项经费开支。 4.5 局限性 说明所建议系统尚存在的局限性以及这些问题未能消除的原因。 4.6 技术条件方面的可行性 本节应说明技术条件方面的可行性，如： a.在当前的限制条件下，该系统的功能目标能否达到。 b.利用现有的技术，该系统的功能能否实现。 c.对开发人员的数量和质量的要求并说明这些要求能否满足。 d.在规定的期限内，本系统的开发能否完成。

扼要说明曾考虑过的每一种可选择的系统方案，包括需开发的和可从国内国外直接购买的，如果没有供选择的系统方案可考虑，则说明这一点。 5.1 可选择的系统方案1 说明可选择的系统方案1,并说明它未被选中的理由。 5.2 可选择的系统方案2 按类似5.1条的方式说明第2个乃至第〃个可选择的系统方案。

本章用来说明对社会因素方面的可行性分析的结果，包括： 7.1 法律方面的可行性 法律方面的可行性问题很多，如合同责任、侵犯专利权、侵犯版权等方面的陷阱，软件人员通常是不熟悉的，有可能陷入，务必要注意研究。 7.2 使用方面的可行性 例如从用户单位的行政管理、工作制度等方面来看，是否能够使用该软件系统；从用户单位的工作人员的素质来看，是否能满足使用该软件系统的要求等，都是要考虑的。

在进行可行性研究报告的编制时，必须有一个研究的结论。结论可以是： a.可以立即开始进行。 b.需要推迟到某些条件（例如资金、人力、设备等）落实之后才能开始进行。 c.需要对开发目标进行某些修改之后才能开始进行。 d.不能进行或不必进行（例如因技术不成熟、经济上不合算等）。