软件文档列表及文档标识说明
- 格式:doc
- 大小:106.50 KB
- 文档页数:5
对应大规模软件所规定的文件可进一步细分测试分析报告项目开发总结小规模软件中规模软件大规模软件超大规模软件操作手册(GB8567——88)1引言1.1编写目的说明编写这份操作手册的目的,指出预期的读者。
1.2前景说明:a.这份操作手册所描述的软件系统的名称;b.该软件项目的任务提出者、开发者、用户(或首批用户)及安装该软件的计算中心。
1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料列出有用的参考资料,如:a.本项目的经核准的计划任务书或合同、上级机关的批文;b.属于本项目的其他已发表的文件;c.本文件中各处引用的文件、资料,包括所列出的这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。
2软件征述2.1软件的结构结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。
2.2程序表列出本系统内每个程序的标识符、编号和助记名。
2.3文卷表列出将由本系统引用、建立或更新的每个永久性文卷,说明它们各自的标识符、编号、助记名、存储媒体和存储要求。
3安装与初始化一步一步地说明为使用本软件而需要进行的安装与初始化过程,包括程序的存载形式,安装与初始化过程中的全部操作命令,系统对这些命令的反应与答复,表征安装工作完成的测试实例等。
如果有的话,还应说明安装过程中所需用到的专用软件。
4运行说明所谓一个运行是指提供一个启动控制信息后,直到计算机系统等待另一个启动控制信息时为止的计算机系统执行的全部过程。
4.1运行表列出每种可能的运行,摘要说明每个运行的目的,指出每个运行各自所执行的程序。
4.2运行步骤说明从一个运行转向另一个运行以完成整个系统运行的步骤。
4.3运行1(标识符)说明把运行1的有关信息,以对操作人员为最方便最有用的形式加以说明。
4.3.1运行控制列出为本运行所需要”的运行流向控制的说明。
4.3.2操作信息给出为操作中心的操作人员和管理人员所需要的信息,如:a.运行目的;b.操作要求;c.启动方法如应请启动(由所遇到的请求信息启动)、预定时间启动、…,··等;d.预计的运行时间和解题时间;e.操作命令;f.与运行有联系的其他事项。
标识:密级:版本:××技术文件{子系统名称}软件需求规格说明中国电子科技集团公司第十五研究所二○一年月{子系统名称} 软件需求规格说明拟制:审核:会签:质量保证:批准:文档修改记录目次1范围 (1)1.1标识 (1)1.2系统概述 (1)1.2.1项目背景 (1)1.2.2业务范围 (1)1.2.3软件边界 (1)1.2.4系统角色 (1)1.3文档概述 (2)1.4术语及缩略语 (2)2引用文档 (2)3功能需求/GN (2)3.1功能概述 (2)3.1.1 XX功能/XX功能标识 (3)3.1.2 YY功能/YY功能标识 (3)3.2用例 (4)3.2.1 XX功能/XX功能标识 (4)3.2.2 YY功能/YY功能标识 (4)3.3需求动态关系 (5)3.4用例与建模 (5)3.4.1 XX功能/XX功能标识 (5)3.4.2 YY功能/YY功能标识 (7)4接口需求/JK (8)4.1外部接口需求/JK-WB (8)4.1.1接口标识和接口图 (8)4.1.2人机交互界面接口 (10)4.1.3 XX接口名称/标识 (10)4.2内部接口需求/JK-NB (12)4.2.1接口标识和接口图 (12)4.2.2 XX接口名称/标识 (12)5数据需求/SJ (12)5.1入、出库单/SJ-IOL (12)5.2数据需求名称/标识 (13)6非功能性需求 (14)6.1性能需求 (14)6.1.1容量估算 (14)6.1.2性能指标/XN (14)6.2适应性需求/SY (14)6.3安全性需求/AQ (14)6.4保密性需求/BM (15)6.5备份与恢复/BH (15)6.6数据移植/YZ (15)6.7标准需求/BZ (16)6.8环境需求/HJ (16)6.8.1硬件环境 (17)6.8.2软件环境 (17)6.8.3网络环境 (17)6.8.4其他环境 (17)6.9计算机资源需求/ZY (17)6.10软件质量因素及可靠性/ZK (18)6.10.1软件质量因素/ZK-YS (18)6.10.2可靠性需求/ZK-KK (18)6.11设计和实现约束/YS (18)6.12需求的关、重程度 (18)6.13人员需求 (19)6.14培训需求 (20)6.15软件保障需求 (20)6.16验收、交付时的包装需求 (20)7合格性规定 (20)8与上级设计文档的可追溯性 (20)8.1正向追溯 (21)8.2逆向追溯 (21)9附件 (21)9.1界面需求 (21)9.2导出文档/报表模版格式 (21)1 范围1.1 标识本文档的标题:本文档的标识:本文档的版本号:1.2 系统概述如果软件应满足不同的工作模式(如演习训练、教学)要求,应在本节中增加章节说明软件应满足的不同工作模式,以及在不同工作模式下应满足的功能、非功能的要求。
密级:(软件项目名称)软件需求规格说明标识:版本:页数:拟制:SQA审核:审核:批准:拟制部门:年月日修改文档历史记录:日期版本说明修改人目录1 范围 (1)1。
1 标识 (1)1.2 系统概述 (1)1.3 文档概述 (1)2 引用文档 (1)3 需求 (1)3。
1 要求的状态和方式 (1)3.2 CSCI能力需求 (4)3。
2。
X(CSCI能力) (4)3.3 CSCI外部接口需求 (5)3。
3.1 接口标识和接口图 (5)3。
3.X(接口的项目唯一的标识符) (5)3。
4 CSCI内部接口需求 (8)3。
5 CSCI内部数据需求 (9)3。
6 适应性需求 (9)3。
7 安全性需求 (9)3.8 保密性需求 (10)3.9 CSCI环境需求 (10)3.10 计算机资源需求 (10)3.10。
1 计算机硬件需求 (10)3。
10。
2 计算机硬件资源使用需求 (11)3.10。
3 计算机软件需求 (11)3.11 软件质量因素 (11)3。
12 设计和实现约束 (12)3.13 人员需求 (12)3。
14 培训需求 (12)3.15 后勤保障需求 (12)3.16 其它需求 (12)3.17 验收、交付和包装需求(修改有关内容) (12)3.18 需求的优先顺序和关键程度 (13)4 合格性规定 (13)5 需求可追踪性 (13)6 注释 (14)1 范围1.1 标识【本条应描述本文档所适用的系统和软件的完整标识,适用时,包括其标识号、名称、缩略名、版本号及发布号。
】示例:系统标识如下:a)已批准的标识号:b)产品名称:XXXXXXc)产品代号:XXXXXXd)版本号:XXXXXe)缩略名:1。
2 系统概述【本条应概述本文档所适用的系统和软件的用途。
它还应描述系统与软件的一般特性;概述系统开发、运行和维护的历史;标识项目的需方、用户、开发方和保障机构;标识当前和计划的运行现场;列出其它有关文档.】示例:a)软件用途:b) 系统概述:c) 需方:XXXXXd) 开发方:软件开发组e) 运行环境:XXXXXf)相关文档:以下描述相关技术数据内容:1) 软件开发计划2) 软件研制任务书3) .。
软件过程管理指南通过整理的软件过程管理指南相关文档,渴望对大家有所扶植,感谢观看!软件过程管理指南Software Process Manage Guide 文档标识:上海易宝软件有限公司深圳分公司修订记录版本说明作者批准批准日期V1.0 第一次发布曾奋瑞Marco 2007-03-01 目录软件过程管理指南1 1 序言8 1.1 简介8 1.2 目标8 1.3 适用范围8 1.4 术语8 2 文件清单9 2.1 软件项目策划PP 9 2.2 软件项目跟踪与监督PTO 9 2.3 需求管理RM 10 2.4 软件生命周期LC 10 2.5 软件质量保证SQA 12 3 项目过程12 4 组间协作15 5 关键实践集15 5.1 项目打算16 5.2 软件估计16 5.3 启动会议16 5.4 迭代开发17 5.5 设计界面雏形与用例说明17 5.6 特征跟踪19 5.7 设计领域模型19 5.8 具体设计19 5.9 运用项目工作管理系统20 5.10 里程碑会议21 5.11 风险清单22 5.12 技术评审22 5.13 建立配置库24 5.14 变更限制25 5.15 组件重用26 5.16 持续集成27 5.17 单元测试27 5.18 启动测试流程28 5.19 缺陷管理28 5.20 系统发布31 5.21 实施管理32 5.21.1 实施型项目月支配32 5.21.2 实施型项目月报33 5.21.3 系统发布说明33 5.22 产品与项目管理33 5.23 客户问题管理34 5.24 软件质量保证34 6 图表索引37 7 引用的过程及规程文件列表37 1 序言 1.1 简介上海易宝软件有限公司深圳分公司的各级管理人员和各个开发组都相识到,只有通过不断的过程改进才能使我们人员的实力和先进的技术得到充分的发挥。
因此,公司确定接受软件实力成熟度模型(CMMI3 )这一标准来提高软件组织的工作效率、产品质量和项目的可预见性。
软件开发文档说明(又全又详细)在软件行业有一句话:一个软件能否顺利的完成并且功能是否完善,重要是看这个软件有多少文档,软件开发文档是一个软件的支柱,如果你的开发文档漏洞百出,那么你所开发出来的软件也不可能会好;开发文档的好坏可以直接影响到所开发出来软件的成功与否。
一、软件开发设计文档:软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计说明书。
1.软件需求说明书:也称为软件规格说明。
该说明书对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。
它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。
软件需求说明书的编制目的的就是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解、并使之面成为整个开发工作的基础。
其格式要求如下:1引言1.1编写目的。
1.2背景1.3定义2任务概述2.1目标2.2用户的特点2.3假定和约束3需求规定3.1对功能的规定3.2对性能的规定3.2.1精度3.2.2时间特性的需求3.2.3灵活性3.3输入输出要求3.4数据管理能力要求3.5故障处理要求3.6其他专门要求4运行环境规定4.1设备4.2支持软件4.3接口4.4控制2.概要设计说明书:又称系统设计说明书,这里所说的系统是指程序系统。
编制的目的是说明对程序系统的设计斟酌,包括程序系统的基本处理。
流程、程序系统的组织结构、模块划分、功能分配、接口设计。
运河行设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。
其花式请求以下:1引言1.1编写目的1.2背景1.3定义1.4参考资料2总体设计2.1需求规定2.2运行环境2.3基本设计概念和处理流程2.4结构2.5功能需求与程序的关系2.6人工处理过程2.7尚未解决的问题3接口设计3.1用户接口3.2外部接口3.3内部接口4运行设计4.1运行模块的组合4.2运行控制4.3运行时间5系统数据结构设计5.1逻辑结构设计要点5.2物理结构设计要求5.3数据结构与程序的关系6系统出错处理设计6.1出错信息6.2补救措施6.3系统维护设计。
软件设计说明目录软件设计说明1范围1.1标识要求:本节应包含这个文档所适用的系统和软件的完全标识,(若适用)应包括标识号、名称、缩略名、版本号及发布号。
1.2系统概述要求:1)本节主要描述本文档适用的系统和软件的用途;2)概述系统开发、运行和维护的历史;3)标识项目的投资方、需方、用户、开发方和保障机构;4)标识当前和计划的运行现场;5)列出其它有关文档。
1.3文档概述本节应概述本文档的用途和内容,描述与它的使用有关的保密性或私密性考虑。
2引用文档列出引用的所有文档,包括文档的编号、标题、修订版本和日期。
3CSCI 级设计决策要求:本章应根据需要分节给出CSCI 级设计决策,即CSCI 行为设计的决策(忽略其内部实现,从用户角度出发描述系统将怎样运转以满足需求)和其它影响组成该CSCI 的软件单元的选择与设计的决策。
如果在需求中所有这些决策是明确的,或者这些决策要推迟到CSCI 的软件单元的设计时指出,则本章应如实陈述。
针对关键性需求(例如对安全性、保密性、私密性等需求)作出的设计决策,应在专门的章节中加以叙述。
CSCI 级设计决策的例子如下:1)关于CSCI 将接收的输入和将产生的输出的设计决策,包括与其它系统、HWCI、CSCI 和用户的接口(本文档的4.3.x 节指出本说明要考虑的主题);2)有关响应每个输入或条件的CSCI 行为的设计决策,包括CSCI 要执行的动作、响应时间和其它性能特性,模型化的物理系统的说明,选定的方程式/算法/规则,以及对不允许的输入或条件进行的处理;3)有关数据库/数据文件如何呈现给用户的设计决策(本文档的4.3.x 节标识了本说明要考虑的主题)。
如果这一信息的全部或部分在数据库设计说明(DBDD)中给出,则可直接引用;4)为满足安全性、保密性、私密性需求所选择的方法;5)为满足需求所做的其它CSCI 级设计决策,例如为提供所需的灵活性、可用性和可维护性所选择的方法。
软件需求⽂档标准格式引⾔1.1 编写⽬的· 阐明开发本软件的⽬的;1.2 项⽬背景· 标识待开发软件产品的名称、代码;· 列出本项⽬的任务提出者、项⽬负责⼈、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项⽬开展⼯作直接有关的⼈员和⽤户;· 说明该软件产品与其他有关软件产品的相互关系。
1.3 术语说明列出本⽂档中所⽤到的专门术语的定义和英⽂缩写词的原⽂。
1.4 参考资料(可有可⽆)列举编写软件需求规格说明时所参考的资料,包括项⽬经核准的计划任务书、合同、引⽤的标准和规范、项⽬开发计划、需求规格说明、使⽤实例⽂档,以及相关产品的软件需求规格说明。
在这⾥应该给出详细的信息,包括标题、作者、版本号、发表⽇期、出版单位或资料来源。
2.项⽬概述2.1 待开发软件的⼀般描述描述待开发软件的背景,所应达到的⽬标,以及市场前景等。
2.2 待开发软件的功能简述待开发软件所具有的主要功能。
为了帮助每个读者易于理解,可以使⽤列表或图形的⽅法进⾏描述。
使⽤图形表⽰,可以采⽤:· 顶层数据流图;· ⽤例UseCase图;· 系统流程图;· 层次⽅框图。
2.3 ⽤户特征和⽔平(是哪类⼈使⽤)描述最终⽤户应具有的受教育⽔平、⼯作经验及技术专长。
2.4 运⾏环境描述软件的运⾏环境,包括硬件平台、硬件要求、操作系统和版本,以及其他的软件或与其共存的应⽤程序等。
2.5 条件与限制给出影响开发⼈员在设计软件时的约束条款,例如:· 必须使⽤或避免使⽤的特定技术、⼯具、编程语⾔和数据库;· 硬件限制;· 所要求的开发规范或标准。
3.功能需求3.1 功能划分列举出所开发的软件能实现的全部功能,可采⽤⽂字、图表或数学公式等多种⽅法进⾏描述。
3.2 功能描述对各个功能进⾏详细的描述。
4.外部接⼝需求4.1 ⽤户界⾯对⽤户希望该软件所具有的界⾯特征进⾏描述。
软件描述文档产品名称公司名称软件基本信息产品名称公司名称1、产品标识:×××软件标识:软件名称:×××软件型号及版本号:×××制造商:×××公司生产地址:×××2、安全性级别××是一种××软件,所以随之而来的软件安全性问题也极为重要。
(a)××软件是一种抽象的逻辑产品,其存在形式是虚拟和动态的……..(b)软件质量的测度十分困难,其质量的控制重点在软件的需求分析和设计阶段,开发过程中产生错误的难以追踪;……;(c)硬件有老化现象,失效曲线似浴盆,硬件的维护可通过纠错、修复或更换失效的系统重新恢复功能。
而软件的维护复杂,只有通过修改代码来排错。
同时软件可能在使用中随着缺陷的发现和消除,而使性能提高。
软件的修改看似比硬件容易,却比硬件更难于控制。
看上去无关紧要的软件代码修改会在软件的其他地方引起无法预测的、十分关键的问题;(d)软件的失效防护困难。
对硬件可采用预防性维护技术预防故障,采用断开失效部件的办法诊断故障,而软件则不能采用这些技术;但软件的失效会毫无征兆的出现,会因执行一条未经验证的路径而出现故障;而同一软件的冗余不能提高可靠性。
(e)软件的失效是系统性失效,其失效的条件有时比较复杂。
因此,可能会无法清晰地洞察其原因,而误归结其为系统中硬件的随机失效。
导致无法及时排除软件中的故障,造成隐患的长期存在。
以上论述了××软件的复杂性,以及出现问题无法预测性和软件的实效防护困难。
××软件一旦出现问题则很可能导致患者×××或者对患者造成严重的伤害,例如,×××软件一旦在运行过程中失效,机器停止工作则很可能导致患者由于××而变为×××,所以××软件安全性级别为××级。
软件版本说明(SVD)软件版本说明(SVD)说明:1.《软件版本说明》(SVD)标识并描述了由一个或多个计算机软件配置项(CSCI)组成的一个软件的版本。
它被用于发行、追踪以及控制软件的版本。
2.术语”版本”可用于软件的最初发行,用于其后续的发行,或用于在几乎同时发行的软件的多种形式之一(例如,用于不同的场所等)。
软件版本说明的正文的格式如下:1引言本章应分为以下几条。
1.1标识本条应包含本文档适用的系统和软件的完整标识,(若适用)包括标识号、标题、缩略词语、版本号和发行号。
它也应标识SVD预期的接受者和该标识影响发行软件的内容的程度(例如,源代码可能不向所有的接受者发行)。
1.2系统概述本条应简述本文档适用的系统和软件的用途。
它应描述系统和软件的一般特性;概述系统的开发、运行与维护的历史;标识项目的投资方、需方、用户、开发方和支持机构;标识当前和计划的运行现场;并列出其他有关的文档。
1.3文档概述本条应概述本文档的用途和内容,并描述与其使用有关的保密性或私密性要求。
2引用文件本章应列出本文档引用的所有文档的编号、标题、修订版本和日期。
也应标识不能通过正常的供货渠道获得的所有文档的来源。
3版本说明本章应分为以下几条。
3.1发行材料清单(若适用)本条应通过标识号、标题、缩略语、日期、版本号和发行号列出构成发行软件的所有物理媒体(例如列表、磁带、磁盘)和有关的文档。
它应包括适用于这些项的保密性和私密性要求、处理它们的安全措施(例如对静电和磁场的关注)和关于复制和许可证条款的说明和制约。
3.2软件内容清单(若适用)本条应通过标识号、标题、缩略语、日期、版本号和发行号列出构成发行软件版本的所有计算机文件。
应包含适用的保密性和私密性要求。
3.3已安装的变更本条应包含一张列表,记录当前的软件版本自上一个版本后引人的所有变更。
如果使用了变更类别,则变更应按这些类别进行划分。
(若适用)本条应标识与每一变更和(若有)每一变更对系统运行和其他软硬件接口产生的影响相关的问题报告、变更建议和变更通告。