文档介绍:软件开发文档标准
一、计算机软件产品开发文件编制指南 1
二、可行性研究报告 5
三、项目开发计划 10
四、软件需求说明书 11
五、数据要求说明书 13
六、概要设计说明书 15
件代替之时止,被认为是该软件的一个生存周期。一般地说这个软件生
存周期可以分成以下六个阶段:
可行性与计算机研究阶段
需求分析阶段
设计阶段
实现阶段
测试阶段
运行与维护阶段
在可行性研究与计划阶段内,要确定该软件的开发目标和总的要求,要进行可行性分析、 投资
一收益分析、制订开发计划,并完成应编制的文件。
在需求分析阶段内, 由系统分析人员对被设计的系统进行系统分析, 确定对该软件的各项功能、
性能需求和设计约束,确定对文件编制的要求,作为本阶段工作的结果,一般地说,软件需求说明书、数据要求说明书和初步的用户手册应该编写出来。
在设计阶段内, 系统设计人员和程序设计人员应该在反复理解软件需求的基础上, 提出多个设
计,分析每个设计能履行的功能并进行相互比较,最后确定一个设计,包括该软件的结构、模块的
划分、 功能的分配以及处理流程。在被设计系统比较复杂的情况下,设计阶段应分解成概要设计阶
段和详细设计阶段两个步骤。在一般情况下,应完成的文件包括:概要设计说明书、详细设计说明
书和测试计划初稿。
在实现阶段内,要完成源程序的编码、编译(或汇编)和排错调试得到无语法错的程序清单,
要开始编写模块开发卷宗,并且要完成用户手册、 操作手册等面向用户的文件的编写工作, 还要完
成测试计划的编制。
在测试阶段,该程序将被全面地测试,已编制的文件将被检查审阅。一般要完成模块开发卷宗
和测试分析报告,作为开发工作的结束,所生产的程序、文件以及开发工作本身将逐项被评价,最
后写出项目开发总结报告。
在整个开发过程中(即前五个阶段中),开发集体要按月编写开发进度月报。
在运行和维护阶段, 软件将在运行使用中不断地被维护, 根据新提出的需求进行必要而且可能
的扩充和删改。
对于一项软件而言, 其生存周期各阶段与各种文件编写工作的关系可见表, 其中有些文件的编
写工作可能要在若干个阶段中延续进行。
文件编制中的考虑因素
文件编制是一个不断努力的工作过程。是一个从形成最初轮廓,经反复检查和修改,直到程序
和文件正式交付使用的完整过程。 其中每一步都要求工作人员做出很大努力。 要保证文件编制的质量,要体现每个开发项目的特点, 也要注意不要花太多的人力。 为此,编制中要考虑如下各项因素。
文件的读者
-可编辑修改 -
______________________________________________________________________________________________________________
第一种文件都具有特定的读者。 这些读者包括个人或小组、 软件开发单位的成员或社会上的公众、从事软件工作的技术人员、 管理人员或领导干部。 他们期待着使用这些文件的内容来进行工作,例如设计、编写程序、测试、使用、维护或进行计划管理。因此,这些文件的作者必须了解自己的
读者,这些文件的编写必须注意适应自己的特定读者的水平、特点和要求。
重复性
本指南第二篇中将列出的这十四种文件的内容要求中, 显然存在某些重复。 较明显的重复有两
类。引言是第一种文件都要包含的内容, 以向读者提供总的梗概。 第二类明显的重复是各种文件中的说明部分,如对功能性能的说明、对输入和输出的描述、系统中包含的设备等。这是为了方便每
种文件各自的读者, 每种产品文件应该自成体系, 尽量避免读一种文件时又不得不去参考另一种文件。当然,在每一种文件里,有关引言、说明等同其他文件相重复的部分,在行文上、在所用的术语上、在详细的程度上,还是应该有一些差别,以适应各种文件的不同读者的需要。
灵活性
鉴于软件开发是具有创造性的脑力劳动, 也鉴于不同软件在规模上和复杂程序上差别极大, 本
指南认为在文件编制工作中应允许一定的灵活性。这种灵活性表现在如下各款。
应编制的文件种类
尽管本指南认为在一般情况下, 一项软件的开发过程中, 应产生的文件有十四种, 然而针对一项具体的软件开发项目,有时不必编制这么多的文件,可以把几种文件合并成一种。一般地说,当
项目的规模、 复杂性和成败风险增大时, 文件编制的范围、 管理手续和详