文档应该是软件过程的"支持过程类"(请看本版软件过程一文);
一、标准的软件开发过程
软件开发的标准过程包括六个阶段,而六个阶段需要编写的各类文件达14种之多,在每个阶段需要编写哪些文件,以及这些文件的主要内容见下:
1.可行性与计划研究阶段
(1)可行性研究报告:在可行性研究与计划阶段内,要确定该软件的开发目标和总的要求,要进行可行性分析、投资一收益分析、制订开发计划,并完成应编制的文件。
(2)项目开发计划:编制项目开发计划的目的是用文件的形式,把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需软、硬件条件等问题作出的安排记载下来,以便根据本计划开展和检查本项目的开发工作。
2.需求分析阶段
(1)软件需求说明书:软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解,使之成为整个开发工作的基础。内容包括对功能的规定对性能的规定等。
(2)数据要求说明书:数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。
(3)初步的用户手册:用户手册的编制是要使用非专门术语的语言,充分地描述该软件系统所具有的功能及基本的使用方法。使用户(或潜在用户)通过本手册能够了解该软件的用途,并且能够确定在什么情况下,如何使用它。
3.设计阶段
(1)概要设计说明书:概要设计说明书又可称系统设计说明书,这里所说的系统是指程序系统。编制的目的是说明对程序系统的设计考虑,包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计。运行设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。
(2)详细设计说明书:详细设计说明书又可称程序设计说明书。编制目的是说明一个软件系统各个层次中的每一个程序(每个模块或子程序)的设计考虑,如果一个软件系统比较简单,层次很少,本文件可以不单独编写,有关内容合并入概要设计说明书。
(3)数据库设计说明书:数据库设计说明书的编制目的是对于设计中的数据库的所有标识、逻辑结构和物理结构作出具体的设计规定。
(4)测试计划初稿:这里所说的测试,主要是指整个程序系统的组装测试和确认测试。本文件的编制是为了提供一个对该软件的测试计划,包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整理方法及评价准则。
4.实现阶段
(1)模块开发卷宗(开始编写):模块开发卷宗是在模块开发过程中逐步编写出来的,每完成一个模块或一组密切相关的模块的复审时编写一份,应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总低层次开发的进度和结果,以便于对整个模块开发工作的管理和复审,并为将来的维护提供非常有用的技术信息。
(2)用户手册完工
(3)操作手册:操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识,包括操作方法的细节。
(4)测试计划终稿:
5.测试阶段
(1)模块开发卷宗(此阶段内必须完成)
(2)测试分析报告:测试分析报告的编写是为了把组装测试和确认测试的结果、发现及分析写成文件加以记载。
(3)项目开发总结报告:项目开发总结报告的编制是为了总结本项目开发工作的经验,说明实际取得的开发结果以及对整个开发工作的各个方面的评价。
6.运行与维护阶段
开发进度月报的编制目的是及时向有关管理部门汇报项目开发的进展和情况,以便及时发现和处理开发过程中出现的问题。一般地,开发进度月报是以项目组为单位每月编写的。如果被开发的软件系统规模比较大,整个工程项目被划分给若干个分项目组承担,开发进度月报将以分项目组为单位按月编写。
对于一项软件而言,有些文件的编写工作可能要在若干个阶段中延续进行。
鉴于软件开发是具有创造性的脑力劳动,也鉴于不同软件在规模上和复杂程度上差别极大,本指南认为在文件编制工作中应允许一定的灵活性,并不是14种文件每种都必须编写。
二、文件编制的衡量因素
◆在因素总和较低的情况下,项目开发总结报告的内容应包括:程序的主要功能、基本流程、测试结果和使用说明。
◆测试分析报告应该写,但不必很正规。
◆数据要求说明和数据库设计说明是否需要编写应根据所开发软件的实际需要来决定。
例如:为了避免在软件开发中文件编制的不足或过分,一个简便的办法是把对软件文件的编制要求同软件的规模大小联系起来,这就是本例的出发点。软件的规模不妨分为四级:
1.小规模软件源程序行数小于5000的软件;
2.中规模软件源程序行数为10000~50000的软件;
3.大规模软件源程序行数为100000?500000的软件;
4.特大规模软件源程序行数大于500000的软件。
对上述的四级软件的文件编制要求分别列于表O3。
至于源程序行数为5000~10000,50000~100000的软件,其文件编制要求介于两级之间,可根据一个软件产品的具体情况,由项目负责人参照表O3的规定,确定需要编制的文件种类。
对于源程序行数大于500000的特大规模软件,可进一步把本指南规定的十四种文件按实际需要扩展成更多种类。
分享到:
相关推荐
"软件开发文档编写标准范本"是指导开发者按照规范化、标准化的方式来撰写各类文档的重要工具。这个文档通常包括多个组成部分,如需求规格说明书、设计文档、测试计划和用户手册等,旨在确保整个开发过程的透明度和可...
"软件开发文档标准"强调了规范化的文档编写和管理对于一个项目的成功至关重要。以下是对这一主题的详细阐述: 1. **需求规格说明书**:这是项目启动阶段的关键文档,它详细描述了用户的需求、系统的功能以及预期的...
本文将深入探讨“软件开发文档编写要求”,基于给出的标签“源码”和“工具”,并参考博文链接中的内容,我们将讨论如何有效地编写软件开发文档,以及与源码管理和开发工具相关的要点。 首先,我们要明确软件开发...
在软件开发过程中,国家标准文档是指导项目顺利进行的重要依据,它们确保了开发团队遵循一致的规范,提高了软件质量,降低了沟通成本。以下是一些关键的软件工程国家标准文档及其详细内容: 1. **需求规格说明书**...
本课程“软件开发文档编写标准及源码”针对大四学生,旨在教授如何按照规范撰写各类关键文档,确保软件开发过程的高效与专业。以下是关于这些文档的详细解释: 1. **需求规格说明书**:这是软件开发的起点,详细...
在软件开发过程中,软件文档扮演着至关重要的角色。软件文档是指与软件开发、维护和使用相关的文字材料,它是软件的必要组成部分,不仅包括程序代码,还涵盖了从需求分析到后期维护的各种规范、报告和指南。良好的...
《软件开发文档编写标准范本 ISO9001(2000版)》是针对软件开发过程中的文档规范提供的一套详细指南,旨在确保软件产品的质量、可维护性和可追溯性。ISO9001是国际标准化组织(ISO)制定的一套质量管理标准,其2000版...
《国家软件开发文档编写规范》是中国信息化建设领域的一项重要指导性文件,旨在为软件开发团队提供一套统一、标准的文档编制方法,确保软件项目的高效、规范进行。文档编写规范是软件开发过程中的基石,它涵盖了从...
以下是根据标题和描述概括出的软件开发核心流程及其中涉及的重要知识点: 1. 需求分析: 在这一阶段,团队需要与客户进行深入沟通,理解他们的业务需求,明确软件的目标和功能。需求分析文档是这一阶段的关键产出...
标题提到的"软件开发过程文档+软件设计文档国家标准"涵盖了两个核心部分:软件开发过程管理和软件设计的标准指导。这些文档是软件工程的重要组成部分,旨在规范开发流程,提高工作效率,保证产品质量。 1. **软件...
"软件开发项目文档编写模板"提供了一套全面的标准,帮助开发者和团队高效地管理项目并确保质量。以下是对标题、描述及标签所涉及知识点的详细说明: 1. 需求分析文档:这是项目开始时的核心文档,它明确了软件的...
在软件开发过程中,技术文档是不可或缺的一部分,它记录了项目的全过程,从需求分析到系统设计,再到编码实现和测试验证,每一个环节都有相应的文档作为支持。"概要设计说明书"是其中的重要一环,它是软件设计阶段的...
这份文档深入阐述了软件开发过程中的各个环节,从需求分析到项目结束,每一个步骤都有明确的操作指南,确保团队在开发过程中能够遵循统一的标准,从而提高产品质量,减少不必要的返工。 一、需求管理 需求管理是...
本文档的主要目的是指导开发团队成员遵循软件开发的标准流程,确保软件的开发是有序、有计划、有质量的。 需求分析是软件开发的第一步骤,它的目的是收集和定义软件的需求信息。在需求分析阶段,开发团队需要收集...
本文将深入探讨“软件开发文档标准及范例”这一主题,结合ISO标准、SPP2.0以及国家标准的项目开发文档格式,为你揭示一套完整的文档编制流程。 首先,我们需要理解“软件工程文档”的概念。它是软件开发过程中的蓝...
在软件开发过程中,编写文档是至关重要的一个环节。这些文档不仅是团队沟通的桥梁,也是确保项目按计划进行、质量得到保证的重要工具。以下是对标题和描述中提到的几个关键文档的详细说明: 1. **项目开发计划**:...
通过这些文档,软件开发团队可以遵循一套标准化的过程,确保项目的顺利进行。每个文档都有其特定的目的和价值,它们共同构成了软件生命周期管理的重要组成部分。编写和维护这些文档是专业软件开发不可或缺的环节,...
《ISO软件开发全套文档_测试计划编写指南_.pdf》是一份详细指导软件开发过程中测试计划编写的文档,旨在为测试负责人提供明确的步骤和策略,确保软件的质量与可靠性。该文档由Chicony Software Inc.于2002年制定,...
计算机软件开发文档是软件工程中的重要组成部分,它们记录了项目的全过程,从初步的构思到最终的产品,确保开发工作的规范性和可追溯性。以下是对这些关键文档的详细解释: 1. **可行性分析报告**:这份报告旨在...
"软件开发过程中所需要文档.zip"这个压缩包很可能包含了从项目启动到交付的全过程所需的各种文档模板和规范,这对于遵循国家标准的软件开发至关重要。 首先,我们要了解软件开发中的主要文档类型: 1. **需求规格...