计算机--软件开发文档标准 .docx
《计算机--软件开发文档标准 .docx》由会员分享,可在线阅读,更多相关《计算机--软件开发文档标准 .docx(78页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、计算机-软件开发文档标准 软件开发文档标准一、计算机软件产品开发文件编制指南?错误 !未定义书签。二、可行性探讨报告?错误!未定义书签。三、项目开发安排.错误 ! 未定义书签。四、软件需求说明书.错误 ! 未定义书签。五、数据要求说明书.错误 ! 未定义书签。六、概要设计说明书七、具体设计说明书?错误 ! 未定义书签。.错误 ! 未定义书签。八、数据库设计说明书?错误 ! 未定义书签。九、用户手册 ?错误!未定义书签。十、操作手册 .错误 ! 未定义书签。十一、模块开发卷宗.错误 ! 未定义书签。十二、测试安排 ?错误!未定义书签。十三、测试分析报告.错误 ! 未定义书签。十四、开发进度月报?
2、错误!未定义书签。十五、项目开发总结报告?错误 !未定义书签。一、计算机软件产品开发文件编制指南目得一项计算机软件得筹划、研制及实现, 构成一个软件开发项目。一个软件开发项目得进行,一般须要在人力与自动化资源等方面作重大得投资。为了保证项目开发得胜利,最经济地花费这些投资,并且便于运行与维护,在开发工作得每一阶段,都须要编制二定得文件。这些文件连同计算机程序及数据一起,构成为计算机软件。文件就是计算机软件中不行缺少得组成部分,它得作用就是 :、作为开发人员在肯定阶段内得工作成果与结束标记;b 、向管理人员供应软件开发过程中得进展与状况, 把软件开发过程中得一些不行见得 " 事
3、物转换成 可见 "得文字资料, 以便管理人员在各个阶段检查开发安排得实施进展,使之能够推断原定目标就是否已达到,还将接着耗用资源得种类与数量;、记录开发过程中得技术信息,便于协调以后得软件开发、运用与修改;d 、供应对软件得有关运行、维护与培训得信息,便于管理人员、开发人员、操作人员与用户之间相互了解彼此得工作;e、向潜在用户报导软件得功能与性能,使她们能判定该软件能否服务于自己得须要.换言之,本指南认为: 文件得编制必需适应计算机软件整个生存周期得须要。计算机软件所包含得文件有两类:一类就是开发过程中填写得各种图表,可称之为工作表格;另一类则就是应编制得技术资料或技术管理资
4、料,可称之为文件。本指南规定软件文件得编制形式,并供应对这些规定得说明。本指南得目得就是使得所编制得软件文件的确能够起到软件文件应当发挥得作用 .2范围本指南就是一份指导性文件。本指南建议,在一项计算机软件得开发过程中,一般地说,应当产生十四种文件。这十四种文件就是:可行性探讨报告;项目开发安排;软件需求说明书;数据要求说明书 ;概要设计说明书; 具体设计说明书;数据库设计说明书 ;用户手册;操作手册 ;模块开发卷宗;测试安排;测试分析报告;开发进度月报;本指南将给出开发过程中建议产生得这十四种文件得编制指导,同时 ,本指南也就是这十四种文件得编写质量得检验准则。但就是,本指南并未涉及软件开发
5、过程中如何填写工作表格得问题。一般地说,一个软件总就是一个计算机系统(包括硬件、固件与软件)得组成部分。鉴于计算机系统得多样性,本指南一般不涉及整个系统开发中得文件编制问题,本指南仅仅就是软件开发过程中得文件编制指南。3文件得运用者对于运用文件得人员而言,她们所关切得文件得种类,随她们所担当得工作而异。管理人员:可行性探讨报告,项目开发安排,模块开发卷宗,开发进度月报,项目开发总结报告 ;开发人员 :可行性探讨报告,项目开发安排,软件需求说明书,数据要求说明书,概要设计说明书,具体设计说明书,数据库设计说明书,测试安排, 测试分析报告;维护人员:设计说明书,测试分析报告,模块开发卷宗;用户 :
6、 用户手册 ,操作手册。尽管本指南提出了在软件开发中文件编制得要求,但并不意味着这些文件都必需交给用户。一项软件得用户应当得到得文件得种类由供应者与用户之间签订得合同规定.软件生存周期与各种文件得编制一项计算机软件,从出现一个构思之日起,经过这项软件开发胜利投入运用,直到最终确定停止使用,并被另一一项软件代替之时止,被认为就是该软件得一个生存周期。一般地说这个软件生存周期可以分成以下六个阶段:可行性与计算机探讨阶段需求分析阶段设计阶段实现阶段测试阶段运行与维护阶段在可行性探讨与安排阶段内,要确定该软件得开发目标与总得要求,要进行可行性分析、投资一收益分析、制订开发安排,并完成应编制得文件。在需
7、求分析阶段内,由系统分析人员对被设计得系统进行系统分析,确定对该软件得各项功能、性能需求与设计约束,确定对文件编制得要求,作为本阶段工作得结果,一般地说,软件需求说明书、数据要求说明书与初步得用户手册应当编写出来。在设计阶段内, 系统设计人员与程序设计人员应当在反复理解软件需求得基础上,提出多个设计 ,分析每个设计能履行得功能并进行相互比较,最终确定一个设计,包括该软件得结构、模块得划分、功能得安排以及处理流程。在被设计系统比较困难得状况下,设计阶段应分解成概要设计阶段与具体设计阶段两个步骤。在一般状况下,应完成得文件包括: 概要设计说明书、具体设计说明书与测试安排初稿。在实现阶段内, 要完成
8、源程序得编码、编译(或汇编)与排错调试得到无语法错得程序清单,要开始编写模块开发卷宗 ,并且要完成用户手册、操作手册等面对用户得文件得编写工作,还要完成测试安排得编制。 在测试阶段,该程序将被全面地测试, 已编制得文件将被检查批阅. 一般要完成模块开发卷宗与测试分析报告 , 作为开发工作得结束,所生产得程序、文件以及开发工作本身将逐项被评价,最终写出项目开发总结报告。在整个开发过程中(即前五个阶段中),开发集体要按月编写开发进度月报。在运行与维护阶段,软件将在运行运用中不断地被维护,依据新提出得需求进行必要而且可能得扩充与删改.对于一项软件而言,其生存周期各阶段与各种文件编写工作得关系可见表,
9、其中有些文件得编写工作可能要在若干个阶段中持续进行.5文件编制中得考虑因素文件编制就是一个不断努力得工作过程。就是一个从形成最初轮廓, 经反复检查与修改,直到程序与文件正式交付运用得完整过程.其中每一步都要求工作人员做出很大努力。要保证文件编制得质量 ,要体现每个开发项目得特点,也要留意不要花太多得人力.为此 ,编制中要考虑如下各项因素。5、 1 文件得读者第一种文件都具有特定得读者。这些读者包括个人或小组、软件开发单位得成员或社会上得公众、从事软件工作得技术人员、管理人员或领导干部. 她们期盼着运用这些文件得内容来进行工作,例如设计、编写程序、测试、运用、维护或进行安排管理。因此,这些文件得
10、作者必需了解自己得读者,这些文件得编写必需留意适应自己得特定读者得水平、特点与要求.、 2重复性本指南其次篇中将列出得这十四种文件得内容要求中,明显存在某些重复. 较明显得重复有两类。引言就是第一种文件都要包含得内容,以向读者供应总得梗概.其次类明显得重复就是各种文件中得说明部分,如对功能性能得说明、对输入与输出得描述、系统中包含得设备等。这就是为了便利每种文件各自得读者,每种产品文件应当自成体系,尽量避开读一种文件时又不得不去参考另一种文件 . 当然 ,在每一种文件里,有关引言、说明等同其她文件相重复得部分,在行文上、在所用得术语上、在具体得程度上,还就是应当有一些差别,以适应各种文件得不同
11、读者得须要。、 3 敏捷性鉴于软件开发就是具有创建性得脑力劳动,也鉴于不同软件在规模上与困难程序上差别极大,本指南认为在文件编制工作中应允许肯定得敏捷性。这种敏捷性表现在如下各款。5 3。应编制得文件种类尽管本指南认为在一般状况下,一项软件得开发过程中,应产生得文件有十四种, 然而针对一项具体得软件开发项目,有时不必编制这么多得文件,可以把几种文件合并成一种。一般地说,当项目得规模、困难性与成败风险增大时,文件编制得范围、管理手续与具体程度将随之增加。反之,则可适当削减。为了恰当地驾驭这种敏捷性,本指南要求贯彻分工负责得原则,这意味着:a、一个软件开发单位得领导机构应当依据单位经营承包得应用软
12、件得专业领域与本单位得管理实力,制定一个对文件编制要求得实施规定,主要就是 : 在不同得条件下,应当形成哪些文件?这些文件得具体程序 ?该开发单位得每一个项目负责人,必需仔细执行这个实施规定。这种规定得两个例子可瞧本指南得附录;b 、于一个详细得应用软件项目,项目负责人应依据上述实施规定, 确定一个文件编制安排,主要包括 :( 1)应当编制哪几种文件,具体程序如何( 2)各个文件得编制负责人与进度要求;( 3) 审查、批准得负责人与时间进度支配(4 )在开发时期内,各文件得维护、修改与管理得负责人,以及批准手续。每项工作必需落实到人。这个文件编制安排就是整个开发安排得重要组成部分 ; 、有关得
13、设计人员则必需严格执行这个文件编制安排。5. 2文件得具体程序 从同一份提纲起草得文件得篇幅大小往往不同,可以少到几页,也可以长达几百页。对于这种差别本指南就是允许得。此具体程序取决于任务得规模、困难性与项目负责人对该软件得开发过程及运行环与所须要得具体程度得推断。 .3。3文件得扩展当被开发系统得规模特别大(例如源码超过一百万行)时,一种文件可以分成几卷编写,可以按其。每一个系统分别编制,也可以按内容划分成多卷,例如:项目开发安排可能包括:质量保证安排,配置管理安排,用户培训安排,安装实施安排;系统设计说明书可分写成:系统设计说明书,子系统设计说明书;程序设计说明书可分写成:程序设计说明书,
14、接口设计说明书,版本说明;操作手册可分写成:操作手册,安装实施过程;测试安排可分写成:测试安排,测试设计说明,测试规程,测试用例;测试分析报告可分写成: 综合测试报告,验收测试报告;项目开发总结报告亦可分写成项目开发总结报告与资源环境统计.5。3节得扩张与缩并在有些文件中, 可以运用本指南所供应得章、条标题,但在条内又存在一系列须要分别探讨得因素本指南认为,全部得条都可以扩展, 可以进一步细分,以适应实际须要。反之,假如章条中得有些细微环节 ;非必需,也可以依据实际状况缩并。此时章条得编号应相应地变更。3 5程序设计得表现形式本指南对于程序得设计表现形式并未作出规定或限制,可以运用流程图得形式
15、、判定表得形式,可以运用其她表现形式,如程序设计语言(P )、问题分析图(D) 等。5.3 。文件得表现形式本指南对于文件得表现形式亦未作出规定或限制,可以运用自然语言,也可以运用形式化语言.5。3. 文件得其她种类当本指南中规定得文件种类尚不能满意某些应用部门得特别须要时,她们可以建立一些特别得文件种类要求 , 例如软件质量保证安排、软件配置管理安排等,这些要求可以包含在本单位得文件编制实施规定中。6文件编制得管理工作文件编制工作必需有管理工作得协作,才能使所编制得文件真正发挥它得作用. 文件得编制工作事实上贯穿于一项软件得整个开发过程, 因此 ,对文件得管理必需贯穿于整个开发过程.在开发过
16、程中必需进行得管理工作就是以下四条。、 1文件得形成开发集体中得每个成员,尤其就是项目负责人,应当相识到:文件就是软件产品得必不行少得组成部分;在软件开发过程得各个阶段中,必需根据规定刚好地完成各种产品文件得编写工作;必需把在一个开发步骤中作出得确定与取得得结果刚好地定文件;开发集体必需刚好地对这些文件进行严格得评审 ; 这些文件得形成就是各个阶段开发工作正式完成得标记。这些文件上必需有编写者、评审者与批准者得签字,必需有编写、评审完成得日期与批准得日期.6、 2文件得分类与标识在软件开发得过程中,产生得文件就是许多得,为了便于保存、 查找、 运用与修改 , 应当对文件按层次地加以分类组织。一
17、个软件开发单位应当建立一个对本单位文件得标识方法,使文件得每一页都具有明确得标识。例如可以按如下四个层次对文件加以分类与标识。a、文件所属得项目得标识 ; b、文件种类得标识;c、同一种文件得不同版本号 ; d、页号此外,对每种文件还应依据项目得性质, 划定它们各自得保密级别, 确定她们各自得发行范围。6、 3 文件得限制 在一项软件得开发过程中,随着程序得逐步形成与逐步修改,各种文件亦在不断地产生、不断地修改或补充 .因此,必需加以周密得限制 ,以保持文件与程序产品得一样性 ,保持各种文件之间得一样性与文件得平安性。这种限制表现为 :、就从事一项软件开发工作得开发集体而言,应设置一位专职得文
18、件管理人员( 接口管理工程师或文件管理员); 在开发集体中,应当集中保管本项目现有全部文件得主文本两套, 由该文件管理人员负责保管;b 、每一份提交给文件管理人员得文件都必需具有编写人、审核人与批准人得签字 ; c、这两套主文本得内容必需完全一样 ;其中有一套就是可供出借得,另一套就是肯定不能出借得 ,以免发生万一; 可出借得主文本在出借时必需办理出借手续,归还时办理注销出借手续;d 、开发集体中得工作人员可以依据工作得须要,在本项目得开发过程中持有一些文件,即所谓个人文件,包括为使她完成她担当得任务所须要得文件,以及她在完成任务过程中所编制得文件;但这种个人文件必需就是主文本得复制品,必需同
19、主文本完全一样,若要修改,必需首先修改主文本;e、不同开发人员所拥有得个人文件通常就是主文本得各种子集;所谓子集就是指把主文本得各个部分依据担当不同任务得人员或部门得工作须要加以复制、 组装而成得若干个文件得集合; 文件管理人员 . 应当列出一份不同子集得分发对象得清单,根据清单刚好把文件分发给有关人员或部门; f、一份文件假如已经被另一份新得文件所代替,则原文件应当被注销; 文件管理人中要随时整理主文本,刚好反映出文件得改变与增加状况,刚好分发文件;、当一个项目得开发工作接近结束时,文件管理人员应逐个收回开发集体内每个成员得个人文 件 ,并检查这些个人文件得内容; 阅历表明,这些个人文件往往
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 计算机-软件开发文档标准 计算机 软件 开发 文档 标准
限制150内