软件概要设计说明模板.docx

XX软件概要设计说明V4.0-1标记数量修改单号签字日期编制XXXX会签软件概要设计说明校对XXXX标检XXXX共23页第1页审核批准XXXX中国船舶工业系统工程研究院会签XXXX修订记录版本号修订状态简要说明修订内容和范围修订日期修订人批准日期注：修订记录在体系文件发布后换版时使用，修订状态栏填写：A一增加，M一修改,D一删除目次1Qkl¾l*21.1标识21.2文档概述22引用文档23CSCI设计决策33. 1假设33.2系统体系结构33.3软件体系结构33.4设计决策43.4.1输入/输出设计决策43.4.2CSCI行为设计决策43.4.3CSCl数据显示设计决策43.4.4CSCI安全性设计决策53.4.5CSCl保密性设计决策63. 4.6其他CSCl级设计决策64CSCl体系结构设计64. 1CSCI包汇总74. 1.1XX包设计74. 2执行方案84. 2.1XX功能/业务84.3 接口设计84.4 .1外部接口84. 3.2内部接口95用户界面设计（可选）105.1应当遵循的界面设计规范105.2界面信息汇总105.3界面视图105. 3.1XX主界面105. 3.2XY主界面1054人因设11（可选）105. 5界面资源设计（可选）105. 5.1图标资源105. 5.2图像资源115. 5.3界面组件116数据（库）结构设计（可选）115.1 逻辑结构设计要点116. 2物理结构设计要点127配置文件设计（若有）126.1 XX配置文件126.2 XX配置文件128部署设计128.1设计部署128. 2物理部署129运行设计（可选）138.1 运行包组合139. 2运行控制149.3运行时间1510性能设计1510. 1XX性能15H系统出错处理设计15H.1出错信息1511.2 补救措施1611.3 系统维护设计1611.4 错误处理设计1612CSCI详细设计1613需求可追踪性1614注释17图序图1XX系统体系结构图3图2XX软件体系结构图4图3CSCl体系结构图7图4XX时序图错误!未定义书签。图5外部接口示意图8图6数据库逻辑结构图11图7XX软件部署设计图13图8运行包组合图14图9运行控制图15表序表1XX软件安全性设计决策表5表2XX软件保密性设计决策表6表3XX软件包汇总表7表4APl接口设计表8表5信息接口设计表9表6信息接口设计表9表7XX软件界面汇总表10表8XX表字段结构11表9XX软件部署设计表12表9XX软件部署设计表13表10需求追踪表（正向）16表11需求追踪表（逆向）171范围1. 1标识本条应描述本文档所适用系统和软件的完整标识，适用时，包括其标识号、名称、缩略名、版本号和发布号。简要说明软件的标识号、发布号、名称、缩略名、版本号。a）软件标识号：b）发布号：VOlc）名称：d）缩略名：e）版本号：VI.0本条应概述本文档所适用系统和软件的用途。它还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构等：标识当前和计划的运行现场；列出其他有关文档。分别简要说明系统的用途、软件用途。a）需方：b）用户：c）开发方：1.2文档概述本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的要求。示例：本文档主要描述XX软件配置项CSCI级的设计决策以及体系结构设计，包括CSCI从部件到软件单元的执行方案、接口说明，满足需求可追踪性，以确保它们完备、可行、可实现和可验证性。2引用文档本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识不能通过正常采购活动得到的文档的来源。a）文档名称1，编号（若有），编写单位，版本（若有），日期；b）文档名称2，编号（若有），编写单位，版本（若有），日期。3CSCI设计决策3.1 假设设计是否基于某种假设的前提条件。3.2 系统体系结构着重从硬件（诸如网络、服务器、终端、打印机等）方面，用图形和文字方法描述软件的体系结构。图片不做形式要求图1XX系统体系结构图用文字的形式对图片中系统的体系结构进行简要描述。3.3软件体系结构着重从软件架构（诸如现有的系统、子系统、层等）方而，用图形和文字方法描述软件的体系结构，如图2所示。应用层可巴产严E严严图2XX软件体系结构图用文字的形式对图片中软件的体系结构进行简要描述,主要包括分层的设计原理（设计模式），每层的主要功能及功能包等。3. 4设计决策本章应根据需要分条给出CSCI级设计决策，即CSCI行为设计的决策（忽略其内部实现，从用户角度出发描述系统将怎样运转以满足需求）和其他影响组成该CSCl的软件单元的选择与设计的决策。如果在需求中所有这些决策是明确的，或者这些决策要推迟到CSCl的软件单元的设计时指出，则本章应如实陈述。针对关键性需求（例如对安全性或保密性关键的需求）作出的设计决策，应在专门的章条中加以叙述。如果设计决策依赖于系统状态或方式，则应指明这一依赖性。本条应给出或引用理解这些设计所需的设计约定。CSCl级设计决策的例子如下：建议项目组主要从以下几个方面进行考虑，也可根据项目特点自行裁剪或添加。4. 4.1输入/输出设计决策关于CSCI将接收的输入和将产生的输出的设计决策，即本软件输入/输出的设计原则。包括与其他系统、HwCI、CSCl和用户的接口。如果这一信息的全部或部分已在接口设计说明（IDD）中给出，则可以直接引用，否则填写下表信息。例如：1）触摸屏输入：由于该系统为ZZ/WQ发控类系统，对发控类命令要求较高，因此诸如工作方式切换、WQ发控命令采用触摸屏设计；2）界面输出：为了提高操作人员的警惕度，软件运行过程中出现的故障信息均用闪烁的红色显示，便于ZZ过程中及时处理。3.4.2CSel行为设计决策有关响应每个输入或条件的CSCl行为的设计决策，即本软件CSCl行为的设计原则。包括CSCl要执行的动作、响应时间。例如：1）为不影响XX设备态势信息处理的准确性，软件态势信息发送到订阅客户端的响应时间为IOOmSo3.4.3CSCl数据显示设计决策有关数据库/数据文件如何呈现给用户的设计决策，即本软件CSCl数据显示的设计原则。如果这一信息的全部或部分在数据库设计说明（DBDD）中给出，则可直接引用。例如：1）文件信息显示：为便于ZZ过程中对目标信息进行直观分析，接收到的目标信息采用态势图的形式显示；2）文件导出：只有软件空闲时，才允许对数据文件的导出。3. 4.4CSCl安全性设计决策CSCI的安全性是指防止其合法用户使用该CSCl时对系统或其中的信息造成不良影响，本条应针对该CSCI的软件需求规格说明中描述的安全性需求，逐一描述其采取的防护措施和方法的设计原则。例如：表1XX软件安全性设计决策表序号安全性需求采取的防护措施1.输入信息的合法性 所有用户录入信息入库前必须进行数据的合法性检查，对非法数据CSel将提示用户修改，直至数据合法方可入库； 对录入信息的必填项进行高亮或特殊颜色提示，入库前进行数据库主键检查； 在各人机界面上进行信息录入说明。2.误操作防护 按照工作流程要求，在软件界面中对功能按钮的状态（有效/无效）进行控制； 编制CSCl运行导航程序； 增加操作撤消与恢复功能。3.信息删除警示 CSCI中所有数据库数据的删除操作均给予用户以删除警示，并由用户进行删除确认后方执行信息删除操作； 用户删除的所有数据文件均存放在系统的回收站中，用户可根据需要还原或清理回收站中的文件。 CSCI中所有数据库数据的删除操作均给予用户以删除警示，并由用户进行删除确认后方执行信息删除操作； 用户删除的所有数据文件均存放在系统的回收站中，用户可根据需要还原或清理回收站中的文件。序号安全性需求采取的防护措施4.数据库访问权限控制 利用数据库管理系统，对不同的用户分配不同的角色，并对其进行可访问信息的范围和访问权限进行设置； 对用户访问数据库的操作进行审计。4. 4.5CSCl保密性设计决策CSCI的保密性主要是防止非法用户对CSCl的攻击。本条应针对该CSCl的软件需求规格说明中描述的保密性需求，逐一描述其采取的防护措施和方法的设计原则。例如：表2XX软件保密性设计决策表序号保密性需求采取的措施1.身份验证启动软件时，首先要求用户输入用户身份信息（用户名和口令），CSCI对其进行比对识别后，合法用户方能够用动运行该软件；对非法用户将给予登陆警示和记录，登陆警示超过X次将退出；使用用户身份卡、读卡器和识别接口卡等设备对本CSCI运行的计算机设备的开关机及软件启动等操作进行控制。2.数据库访问权限控制利用数据库管理系统，对不同的用户分配不同的角色，并对其进行可访问信息的范围和访问权限进行设置；对用户访问数据库的操作进行审计。5. 4.6其他CSCI级设计决策本条可针对本CSCl软件需求规格中的其它特殊需求（如：灵活性、可用性、可维护性等方面的需求），描述其相应的实现方法的设计原则。对有特殊需求的CSCl要求必须填写，如为满足性能指标所进行的负载均衡设计、并行计算或高性能计算设计决策等。如果本节无内容，填写“无。”4CSCI体系结构设计描述CSCI体系结构，明确包之间的依赖关系。图3CSCI体系结构图4. 1CSCl包汇总设计人员确定包的命名规则，确保软件设计文档的风格与代码的风格保持一致。可以从机构的编程规范中摘取或引用（如果存在的话）。另外，描述包的开发类型，包括新研、改进、完全重用、采购等。表3XX软件包汇总表序号标识名称说明开发类型1PAK_MMI_XX2PAK_MMI_XX3PAK_MMI_XX4PAK_MMI_XX5PAK_MMI_XX64. 1.1XX包设计4. 1.1.1功能说明描述包的主要功能。6. 1.1.2性能分配（可选）描述性能指标的在包中的分配情况。4.2执行方案必须覆盖需求中的业务流程。注释：