GJB438B军用软件开发文档通用要求
- 格式:ppt
- 大小:356.00 KB
- 文档页数:87
:密级:【(软件项目名称)软件设计说明~标识:版本:页数:拟制:《SQA审核:审核:批准:拟制部门:&年`月日修改文档历史记录:日期·版本说明修改人【`,~\"(~》目录1 范围........................................................ 错误!未定义书签。
标识..................................................... 错误!未定义书签。
系统概述................................................. 错误!未定义书签。
文档概述................................................. 错误!未定义书签。
2 引用文档.................................................... 错误!未定义书签。
3 CSCI级设计决策.............................................. 错误!未定义书签。
4 CSCI体系结构设计............................................ 错误!未定义书签。
CSCI部件................................................. 错误!未定义书签。
CSCI结构............................................ 错误!未定义书签。
CSC描述............................................. 错误!未定义书签。
CSC名称和项目唯一标识号............................. 错误!未定义书签。
系统状态和模式....................................... 错误!未定义书签。
独家:GJB438标准C版与B版的对比分析一. 概述GJB 438 标准名称为《军用软件开发文档通用要求》[1-2]。
其规定了军用软件开发文档编制的种类、结构、格式和内容等要求。
适用于军用软件开发过程中文档的编制。
软件文档是整个软件开发工作的重要产品,是实行管理、监督、控制软件开发的重要方式。
软件文档把软件开发过程中的一些不可的事物转化为可见的文字资料,便于管理人员在各个阶段检查开发计划的进展情况,以提高软件生产过程的可见性和可控性。
软件文档作为软件产品的一部分,文档的质量在很大程度上决定了软件的质量。
随着装备信息化迅速发展,装备中计算机软件的种类、规模以及安全、保密等属性的要求都迅速增加或提高。
2009年5月25日GJB 438B版标准发布,并于2009年8月1日正式实施,其从软件开发管理的角度,规定了相应的文档编制要求,增加了文档的用途和简要说明,增加了软件研制任务书、软件质量保证计划、软件质量保证报告、软件配置管理计划、软件配置管理报告、软件研制总结报告等。
但在实践运用中发现,系统/子系统设计说明对硬件—软件系统的适用场景、软件研制总结报告对质量控制情况等不够明确,软件配置管理计划、软件质量保证计划等独立形成文档的必要性不够充分等问题,因此,2021年12月30日 GJB 438C 版标准修订发布,并于2022年3月1日正式实施,其保留了GJB 438B 版标准的有效方面,改进不足之处,以适应当前我军装备软件研制的需要。
二. 文档章节对比GJB 438C版标准较GJB 438B版标准增加了2个章节,分别是“总则”“页号/页标记”。
取消了9个章节,分别是“文档编制”“软件研制任务书”“软件配置管理计划”“软件质量保证计划”“软件输入/输出手册”“软件中心操作手册”“计算机操作手册”“软件配置管理报告”“软件质量保证报告”。
将GJB 438B版中“文档编制”“文档结构”合并修订为“文档组成”。
:密级:【(软件项目名称)软件设计说明~标识:版本:页数:拟制:《SQA审核:审核:批准:拟制部门:&年`月日修改文档历史记录:日期·版本说明修改人【`,~\"(~》目录1 范围........................................................ 错误!未定义书签。
标识..................................................... 错误!未定义书签。
系统概述................................................. 错误!未定义书签。
文档概述................................................. 错误!未定义书签。
2 引用文档.................................................... 错误!未定义书签。
3 CSCI级设计决策.............................................. 错误!未定义书签。
4 CSCI体系结构设计............................................ 错误!未定义书签。
CSCI部件................................................. 错误!未定义书签。
CSCI结构............................................ 错误!未定义书签。
CSC描述............................................. 错误!未定义书签。
CSC名称和项目唯一标识号............................. 错误!未定义书签。
系统状态和模式....................................... 错误!未定义书签。
密级:(软件项目名称)软件设计说明标识:版本:页数:拟制:SQA审核:审核:批准:拟制部门:年月日修改文档历史记录:日期版本说明修改人目录1 范围 (1)1。
1 标识 (1)1.2 系统概述 (1)1。
3 文档概述 (1)2 引用文档 (1)3 CSCI级设计决策 (1)4 CSCI体系结构设计 (3)4.1 CSCI部件 (3)4.1。
1 CSCI结构 (4)4.1。
2 CSC描述 (4)4.1。
2.1 CSC名称和项目唯一标识号 (4)4.1.3 系统状态和模式 (5)4。
2 执行方案 (5)4.2.1 CSC数据流与控制流图 (5)4。
2.2 系统状态与模式的数据流与控制流 (6)4.3 接口设计 (7)4。
3.1 接口设计准则 (7)4。
3.2 接口标识和接口图 (7)4.3。
X(接口的项目唯一的标识符) (9)5 CSCI详细设计 (12)5.X(软件单元的项目唯一的标识符,或者一组软件单元的标志符) (12)6 需求可追踪性 (15)7 注释 (15)1 范围1.1 标识【本条应描述本文档所适用的系统和软件的完整标识,适用时,包括其标识号、名称、缩略名、版本号及发布号。
】1。
2 系统概述【本条应概述本文档所适用的系统和软件的用途。
它还应描述系统与软件的一般特性;概述系统开发、运行和维护的历史;标识项目的需方、用户、开发方和保障机构等;标识当前和计划的运行现场;列出其它有关文档。
】1.3 文档概述【本条应概述本文档的用途和内容,并描述与它的使用有关的保密性方面的要求。
】例:本文档描述XXXX系统软件的概要设计和详细设计,其内容和格式遵循GJB438B-2009的要求。
本文档可作为设计评审的基础,编码的依据,软件测试的基准.2 引用文档【本章应列出引用文档的编号、标题、编写单位、修订版本及日期。
还应标识不能通过正常采购活动得到的文档的来源.】例:表X 引用文档3 CSCI级设计决策【本章应根据需要分条给出CSCI级设计决策,即CSCI行为设计的决策(忽略其内部实现,从用户角度出发描述系统将怎样运转以满足需求)和其它影响组成该CSCI的软件单元的选择与设计的决策。
技术文件标识:密级:xxxxxx软件开发计划册号:x/x 总页数:页xxxxXxxxx软件开发计划编写:审核:批准:x年x月x日修改文档历史记录:日期版本说明修改人x V1.0首次提交x1 范围1.1 标识本条应描述本文档所适用的系统和软件的完整标识,适用时,包括其标识号、标题、缩略名、版本号和发行号。
1.2 系统概述本条应概述本文档所适用的系统和软件的用途。
它还应描述系统与软件的一般特性;概述系统开发、运行和维护的历史;标识项目的需方、用户、开发方和保障机构等;标识当前和计划的运行现场;列出其他有关文档。
1.3 文档概述本条应概述本文档的用途和内容,并描述与它的使用有关的保密性方面的要求。
1.4 与其他计划之间的关系本条应描述本计划和其他项目管理计划的关系。
2 引用文档本章应列出引用文档的编号、标题、编写单位、修订版及日期,还应标识不能通过正常采购活动得到的文档的来源。
3 策划背景概述本章按需要可分为若干条,并应对后续章条描述的策划提供背景信息,主要包括如下方面的概述:a)所要开发系统、软件的需求和约束;b)项目文档的需求和约束;c)项目在系统寿命周期中的位置;d)所选用的工程项目/获取策略或其他方面对它的需求或约束;e)项目进度安排及资源的需求与约束;f)其他需求和约束,例如;项目的保密性、方法、标准、硬件和软件开发的相互依赖关系等。
4 软件开发活动的总体实施计划如果项目的不同构建版或不同软件要求不同的策划,就应在下述相应条中注明这些区别。
除下面规定的内容外,每条应标识适用的风险/不确定性和它们的处理计划。
4.1 软件开发过程本条应描述要采用的软件开发过程,软件生存周期模型的定义和选择。
计划的内容应覆盖合同(或软件研制任务书)中涉及该方面要求的所有条款,应包括已标识的计划的构建版,合适时,包括各构建版的目标以及每个构建版要执行的软件开发活动。
4.2 软件开发总体计划4.2.1 软件开发方法本条应描述或引用所使用的软件开发方法,包括为支持这些方法所使用的手工的和自动的工具以及规程的描述。
文档标识及版本号: XX项目标识.IRS V1.0 密级:秘密*5年编制/修订日期:yyyy-mm-dd[规范性]文档名称: XX项目中文名称-接口需求规格说明接口需求规格说明《XX项目中文名称》接口需求规格说明Interface Requirement Specification ofXX项目英文名称编制单位:江苏科技大学新技术研究所编写:CNISILS项目组XXX审核:YYY批准:ZZZ编写记录修改记录目录1 范围 (1)1.1标识 (1)1.2系统概述 (1)1.3文档概述 (1)2 引用文档 (1)3 需求 (2)3.1接口标识和接口图 (2)3.2(接口的项目唯一标识符)【原标准中此处编号为3.X,为后续使用方便,故用自动编号】 (2)3.3需求的优先顺序和关键性【原标准中此处编号为3.Y,为后续使用方便,故用自动编号】 (4)4 合格性规定 (4)5 需求可追踪性 (4)6 注释 (5)文档模板使用和裁剪说明使用本文档模板时,首先另存为“<实际文档名>”,然后通过Word的“文档属性”来设置文档属性,包括:文档标识及版本号、密级及保密期限、文档名称、文档类别(中、英文)、项目名称(中、英文)、编制单位、编写人、审批人、批准人等。
具体操作方法:Word标题栏的Office按钮菜单→准备→属性→文档属性→高级属性→自定义→在“属性”列表中,选择属性的“名称”,在“取值”框输入要设定的值,然后按“更改”按钮。
文档属性设置完成后,选中全部文档内容,执行右键菜单“更新域”操作(文档中的所有文档属性参数引用均被替换为最新设定的取值)→双击任意内容页面的页眉区,选中全部页眉内容,执行右键菜单“更新域”操作(页眉中的所有参数引用均被替换为最新设定的取值)。
本文档模板依据《GJB 438B-2009 军用软件开发文档通用要求》制定,模板中的文档编写说明均引自《GJB 438B-2009 军用软件开发文档通用要求》,并用方括号“【”和“】”括起来,以及使用蓝色文字区分,主要用于指导文档的编写,应在文档编写完成后或正式提交前予以删除(包括删除本说明)。
GJB438B-软件开发计划-模板技术文档标识:密级:xxxxxx软件开发计划册号:x/x 总页数:xxxx 页编写。
审核。
批准:x年x月x日修改文档历史记录:日期版本说明修改人x V1.0 首次提交 x1 范围1.1 标识本条应描述本文档所适用的系统和软件的完整标识,包括标识号、标题、缩略名、版本号和发行号。
1.2 系统概述本条应概述本文档所适用的系统和软件的用途,一般特性,系统开发、运行和维护的历史,需方、用户、开发方和保障机构等相关信息,当前和计划的运行现场,并列出其他有关文档。
1.3 文档概述本条应概述本文档的用途和内容,并描述与它的使用有关的保密性方面的要求。
1.4 与其他计划之间的关系本条应描述本计划和其他项目管理计划的关系。
2 引用文档本章应列出引用文档的编号、标题、编写单位、修订版及日期,还应标识不能通过正常采购活动得到的文档的来源。
3 策划背景概述本章提供背景信息,包括所要开发系统、软件的需求和约束,项目文档的需求和约束,项目在系统寿命周期中的位置,所选用的工程项目/获取策略或其他方面对它的需求或约束,项目进度安排及资源的需求与约束,以及其他需求和约束。
4 软件开发活动的总体实施计划如果项目的不同构建版或不同软件要求不同的策划,就应在相应条中注明这些区别。
除下面规定的内容外,每条应标识适用的风险/不确定性和它们的处理计划。
4.1 软件开发过程本条应描述要采用的软件开发过程,软件生存周期模型的定义和选择。
计划的内容应覆盖合同(或软件研制任务书)中涉及该方面要求的所有条款,应包括已标识的计划的构建版,合适时,包括各构建版的目标以及每个构建版要执行的软件开发活动。
4.2 软件开发总体计划4.2.1 软件开发方法本条应描述或引用所使用的软件开发方法,包括为支持这些方法所使用的手工的和自动的工具以及规程的描述。
该方法应覆盖合同(或软件研制任务书)中涉及该方面要求的所有条款。
如果在本文档方法所适用的活动中,对软件开发方法有更好的描述,则可直接引用。
密级:(软件项目名称)软件设计说明标识:版本:页数:拟制:SQA审核:审核:批准:拟制部门:年月日修改文档历史记录:日期版本说明修改人目录1 范围 (1)1.1 标识 (1)1.2 系统概述 (1)1.3 文档概述 (1)2 引用文档 (1)3 CSCI级设计决策 (1)4 CSCI体系结构设计 (2)4.1 CSCI部件 (2)4.1.1 CSCI结构 (3)4.1.2 CSC描述 (3)4.1.2.1 CSC名称和项目唯一标识号 (3)4.1.3 系统状态和模式 (4)4.2 执行方案 (4)4.2.1 CSC数据流与控制流图 (5)4.2.2 系统状态与模式的数据流与控制流 (5)4.3 接口设计 (6)4.3.1 接口设计准则 (6)4.3.2 接口标识和接口图 (6)4.3.X(接口的项目唯一的标识符) (7)5 CSCI详细设计 (10)5.X(软件单元的项目唯一的标识符,或者一组软件单元的标志符) (10)6 需求可追踪性 (12)7 注释 (12)1 范围1.1 标识【本条应描述本文档所适用的系统和软件的完整标识,适用时,包括其标识号、名称、缩略名、版本号及发布号。
】1.2 系统概述【本条应概述本文档所适用的系统和软件的用途。
它还应描述系统与软件的一般特性;概述系统开发、运行和维护的历史;标识项目的需方、用户、开发方和保障机构等;标识当前和计划的运行现场;列出其它有关文档。
】1.3 文档概述【本条应概述本文档的用途和内容,并描述与它的使用有关的保密性方面的要求。
】例:本文档描述XXXX系统软件的概要设计和详细设计,其内容和格式遵循GJB438B-2009的要求。
本文档可作为设计评审的基础,编码的依据,软件测试的基准。
2 引用文档【本章应列出引用文档的编号、标题、编写单位、修订版本及日期。
还应标识不能通过正常采购活动得到的文档的来源。
】例:表X 引用文档3 CSCI级设计决策【本章应根据需要分条给出CSCI级设计决策,即CSCI行为设计的决策(忽略其内部实现,从用户角度出发描述系统将怎样运转以满足需求)和其它影响组成该CSCI的软件单元的选择与设计的决策。
密级:(软件项目名称)软件设计说明标识:版本:页数:拟制:SQA审核:审核:批准:拟制部门:年月日修改文档历史记录:日期版本说明修改人目录1 范围 (1)1.1 标识 (1)1.2 系统概述 (1)1.3 文档概述 (1)2 引用文档 (1)3 CSCI级设计决策 (1)4 CSCI体系结构设计 (2)4.1 CSCI部件 (2)4.1.1 CSCI结构 (3)4.1.2 CSC描述 (3)4.1.2.1 CSC名称和项目唯一标识号 (3)4.1.3 系统状态和模式 (4)4.2 执行方案 (4)4.2.1 CSC数据流与控制流图 (5)4.2.2 系统状态与模式的数据流与控制流 (5)4.3 接口设计 (6)4.3.1 接口设计准则 (6)4.3.2 接口标识和接口图 (6)4.3.X(接口的项目唯一的标识符) (7)5 CSCI详细设计 (10)5.X(软件单元的项目唯一的标识符,或者一组软件单元的标志符) (10)6 需求可追踪性 (12)7 注释 (12)1 范围1.1 标识【本条应描述本文档所适用的系统和软件的完整标识,适用时,包括其标识号、名称、缩略名、版本号及发布号。
】1.2 系统概述【本条应概述本文档所适用的系统和软件的用途。
它还应描述系统与软件的一般特性;概述系统开发、运行和维护的历史;标识项目的需方、用户、开发方和保障机构等;标识当前和计划的运行现场;列出其它有关文档。
】1.3 文档概述【本条应概述本文档的用途和内容,并描述与它的使用有关的保密性方面的要求。
】例:本文档描述XXXX系统软件的概要设计和详细设计,其内容和格式遵循GJB438B-2009的要求。
本文档可作为设计评审的基础,编码的依据,软件测试的基准。
2 引用文档【本章应列出引用文档的编号、标题、编写单位、修订版本及日期。
还应标识不能通过正常采购活动得到的文档的来源。
】例:表X 引用文档3 CSCI级设计决策【本章应根据需要分条给出CSCI级设计决策,即CSCI行为设计的决策(忽略其内部实现,从用户角度出发描述系统将怎样运转以满足需求)和其它影响组成该CSCI的软件单元的选择与设计的决策。
GJB438B《软件需求规格说明》介绍软件需求规格说明的目的和重要性。
软件需求规格说明是指对软件系统的需求进行详细描述和规范化的文档。
它是软件开发过程中的关键文档之一,用于明确和确保开发人员和用户对软件系统的需求达成一致。
它能够帮助开发团队更好地理解和掌握软件项目的需求,在开发过程中起到指导和约束的作用。
软件需求规格说明的编写具有重要的意义。
首先,它可以帮助开发人员明确软件系统的功能需求,确保软件的功能能够满足用户的需求和期望。
其次,它可以提供对软件系统的详细描述,包括软件系统的功能、性能、数据结构等方面的需求,为开发人员提供清晰的开发方向和依据。
同时,软件需求规格说明也是软件项目验收的依据之一,通过与规格说明的对比可以验证软件开发是否符合需求规范。
因此,编写一份准确、完整、清晰的软件需求规格说明对于软件项目的成功至关重要。
在编写过程中,需要充分了解用户需求,与用户进行充分沟通,并考虑到软件系统的可行性、安全性、可维护性等方面的要求,以确保规格说明的准确性和实用性。
总之,软件需求规格说明作为软件开发过程中必不可少的文档之一,具有重要的指导和约束作用。
通过编写准确、完整的规格说明,可以有效地指导软件项目的开发过程,确保软件系统的功能、性能和质量等方面的需求得到满足,从而实现软件项目的成功交付。
本文档旨在概括性地描述软件需求的范围和目标。
本文档旨在列举和描述软件所需具备的功能要求。
需要实现用户注册和登录功能,包括用户输入账号和密码,系统验证用户信息,并提供相应的错误处理机制。
软件应支持多语言功能,能够根据用户选择的语言显示相应的界面和内容。
用户应能够创建和编辑个人资料,在个人资料中填写个人信息,并能够随时更新和修改。
系统需要提供用户管理功能,包括添加新用户、删除用户、修改用户权限等操作。
软件应支持文件上传和下载功能,用户能够上传文件至系统,其他用户可以下载和查看这些文件。
需要提供搜索功能,用户能够根据关键词搜索相关内容。
GJB438B-2009附录AA(资料性附隶)《软件配置管理报告》的正文格式《软件配置管理报吿》的正文格式如下:1范围1.1 标识本条应描述本文档所适用的系统和软件的完整标识,适用时,包括其标识号、名称、缩略名、版本号和发布号。
1.2 系统概述本条应概述本文档所适用的系统和软件的用途。
它还应描述系统与软件的一般特性;概述系统开发、运行和维护的历史;标识项目的需方、用户、开发方和保障机构等;标识当前和计划的运行现场;列出其他有关文档。
1.3 文档概述本条应概括本文档的用途和内容.并描述与其使用有关的保密性考虑。
2引用文档本章应列出引用文档的编号、标题、编写单位、修订版及日期,还应标识不能通过正常采购活动得到的文档的来源。
3软件配置管理情况综述本章应描述软件配置管理活动进展,与软件配置管理计划的偏差;软件配置管理活动与规程是否相符;对不符合项所采取的措施;完成软件配置管理工作的工作量等。
4软件配置管理基本信息本章应概述软件配置管理的基本信息,包括项目负责人、各级软件配置管理机构组成人员和负责人、软件配置管理所用的资源(如计算机、软件和工具)等。
5专业组划分及权限分配本章应列出项目专亚组的划分、各专业组的成员以及各成员的权限分配,如专业组可分为项目负责人、开发组、测试组、质量保证组、配置管理组等,权限可分为读出、增加、替换、删除等。
6配置项记录本章应列出项目的所有配置项,包括配置项名称、配置项最后发布日期,配置项控制力度(控制力度可分为基线管理、非基线管理(受到管理和控制))、配览项版本变更历史、配置项变更累计次数等内容。
7变更记录本章应列出软件研制过程中的所有变更,包括变更申谘单号、变更时间、变更内容、变更申请人、批准人、变更实施人等内容。
8基线记录本章应列出项目的所有基线,包括基线名称、基线最后一版发布日期、基线版本变更历史、基线变更累计次数、最后一版基线的内容及版本号等内容。
9入库记录本章应列出配置项的入库记录,包括入库时间、入库单号、入库原因、入库申请人和批准人等。