软件概要设计说明模板

页第1页审核批准XXXX中国船舶工业系统工程研究院会签XXXXGr002.6A软件概要设计说明PAGE2修订记录版本号修订状态简要说明修订内容和范围修订日期修订人批准日期注：修订记录在体系文件发布后换版时使用，修订状态栏填写：A—增加，M—修改，D—删除

目次1范围 21.1标识 21.2文档概述 22引用文档 23CSCI设计决策 23.1假设 23.2系统体系结构 23.3软件体系结构 33.4设计决策 33.4.1输入/输出设计决策 43.4.2CSCI行为设计决策 43.4.3CSCI数据显示设计决策 43.4.4CSCI安全性设计决策 43.4.5CSCI保密性设计决策 53.4.6其他CSCI级设计决策 54CSCI体系结构设计 64.1CSCI包汇总 64.1.1XX包设计 64.2执行方案 64.2.1XX功能/业务 74.3接口设计 74.3.1外部接口 74.3.2内部接口 85用户界面设计（可选） 95.1应当遵循的界面设计规范 95.2界面信息汇总 95.3界面视图 95.3.1XX主界面 95.3.2XY主界面 95.4人因设计（可选） 105.5界面资源设计（可选） 105.5.1图标资源 105.5.2图像资源 105.5.3界面组件 106数据（库）结构设计（可选） 106.1逻辑结构设计要点 106.2物理结构设计要点 117配置文件设计（若有） 117.1XX配置文件 117.2XX配置文件 118部署设计 118.1设计部署 118.2物理部署 119运行设计（可选） 129.1运行包组合 129.2运行控制 139.3运行时间 1410性能设计 1410.1XX性能 1411系统出错处理设计 1411.1出错信息 1411.2补救措施 1511.3系统维护设计 1511.4错误处理设计 1512CSCI详细设计 1513需求可追踪性 1514注释 16

图序TOC\h\z\c"图"图1XX系统体系结构图 3图2XX软件体系结构图 3图3CSCI体系结构图 6图4XX时序图 7图5外部接口示意图 8图6数据库逻辑结构图 10图7XX软件部署设计图 12图8运行包组合图 13图9运行控制图 14

表序TOC\h\z\c"表"表1XX软件安全性设计决策表 4表2XX软件保密性设计决策表 5表3XX软件包汇总表 6表4API接口设计表 8表5信息接口设计表 8表6信息接口设计表 8表7XX软件界面汇总表 9表8XX表字段结构 11表9XX软件部署设计表 11表9XX软件部署设计表 12表10需求追踪表（正向） 15表11需求追踪表（逆向） 15范围标识本条应描述本文档所适用系统和软件的完整标识，适用时，包括其标识号、名称、缩略名、版本号和发布号。简要说明软件的标识号、发布号、名称、缩略名、版本号。软件标识号：发布号：V01名称：缩略名：版本号：V1.0本条应概述本文档所适用系统和软件的用途。它还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构等：标识当前和计划的运行现场；列出其他有关文档。分别简要说明系统的用途、软件用途。需方：用户：开发方：文档概述本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的要求。示例：本文档主要描述××软件配置项CSCI级的设计决策以及体系结构设计，包括CSCI从部件到软件单元的执行方案、接口说明，满足需求可追踪性，以确保它们完备、可行、可实现和可验证性。引用文档本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识不能通过正常采购活动得到的文档的来源。《文档名称1》，编号（若有），编写单位，版本（若有），日期；《文档名称2》，编号（若有），编写单位，版本（若有），日期。CSCI设计决策假设设计是否基于某种假设的前提条件。系统体系结构着重从硬件（诸如网络、服务器、终端、打印机等）方面，用图形和文字方法描述软件的体系结构。图片不做形式要求图SEQ图\*ARABIC1XX系统体系结构图用文字的形式对图片中系统的体系结构进行简要描述。软件体系结构着重从软件架构（诸如现有的系统、子系统、层等）方面，用图形和文字方法描述软件的体系结构，如图2所示。图SEQ图\*ARABIC2XX软件体系结构图用文字的形式对图片中软件的体系结构进行简要描述，主要包括分层的设计原理（设计模式），每层的主要功能及功能包等。设计决策本章应根据需要分条给出CSCI级设计决策，即CSCI行为设计的决策(忽略其内部实现，从用户角度出发描述系统将怎样运转以满足需求)和其他影响组成该CSCI的软件单元的选择与设计的决策。如果在需求中所有这些决策是明确的，或者这些决策要推迟到CSCI的软件单元的设计时指出，则本章应如实陈述。针对关键性需求(例如对安全性或保密性关键的需求)作出的设计决策，应在专门的章条中加以叙述。如果设计决策依赖于系统状态或方式，则应指明这一依赖性。本条应给出或引用理解这些设计所需的设计约定。CSCI级设计决策的例子如下：建议项目组主要从以下几个方面进行考虑，也可根据项目特点自行裁剪或添加。输入/输出设计决策关于CSCI将接收的输入和将产生的输出的设计决策，即本软件输入/输出的设计原则。包括与其他系统、HWCI、CSCI和用户的接口。如果这一信息的全部或部分已在接口设计说明(IDD)中给出，则可以直接引用，否则填写下表信息。例如：1）触摸屏输入：由于该系统为ZZ/WQ发控类系统，对发控类命令要求较高，因此诸如工作方式切换、WQ发控命令采用触摸屏设计；2）界面输出：为了提高操作人员的警惕度，软件运行过程中出现的故障信息均用闪烁的红色显示，便于ZZ过程中及时处理。CSCI行为设计决策有关响应每个输入或条件的CSCI行为的设计决策，即本软件CSCI行为的设计原则。包括CSCI要执行的动作、响应时间。例如：1）为不影响XX设备态势信息处理的准确性，软件态势信息发送到订阅客户端的响应时间为100ms。CSCI数据显示设计决策有关数据库/数据文件如何呈现给用户的设计决策，即本软件CSCI数据显示的设计原则。如果这一信息的全部或部分在数据库设计说明(DBDD))中给出，则可直接引用。例如：1）文件信息显示：为便于ZZ过程中对目标信息进行直观分析，接收到的目标信息采用态势图的形式显示；2）文件导出：只有软件空闲时，才允许对数据文件的导出。CSCI安全性设计决策CSCI的安全性是指防止其合法用户使用该CSCI时对系统或其中的信息造成不良影响，本条应针对该CSCI的软件需求规格说明中描述的安全性需求，逐一描述其采取的防护措施和方法的设计原则。例如：表SEQ表\*ARABIC1XX软件安全性设计决策表序号安全性需求采取的防护措施输入信息的合法性所有用户录入信息入库前必须进行数据的合法性检查，对非法数据CSCI将提示用户修改，直至数据合法方可入库；对录入信息的必填项进行高亮或特殊颜色提示，入库前进行数据库主键检查；在各人机界面上进行信息录入说明。误操作防护按照工作流程要求，在软件界面中对功能按钮的状态（有效/无效）进行控制；编制CSCI运行导航程序；增加操作撤消与恢复功能。信息删除警示CSCI中所有数据库数据的删除操作均给予用户以删除警示，并由用户进行删除确认后方执行信息删除操作；用户删除的所有数据文件均存放在系统的回收站中，用户可根据需要还原或清理回收站中的文件。CSCI中所有数据库数据的删除操作均给予用户以删除警示，并由用户进行删除确认后方执行信息删除操作；用户删除的所有数据文件均存放在系统的回收站中，用户可根据需要还原或清理回收站中的文件。数据库访问权限控制利用数据库管理系统，对不同的用户分配不同的角色，并对其进行可访问信息的范围和访问权限进行设置；对用户访问数据库的操作进行审计。CSCI保密性设计决策CSCI的保密性主要是防止非法用户对CSCI的攻击。本条应针对该CSCI的软件需求规格说明中描述的保密性需求，逐一描述其采取的防护措施和方法的设计原则。例如：表SEQ表\*ARABIC2XX软件保密性设计决策表序号保密性需求采取的措施身份验证启动软件时，首先要求用户输入用户身份信息（用户名和口令），CSCI对其进行比对识别后，合法用户方能够启动运行该软件；对非法用户将给予登陆警示和记录，登陆警示超过X次将退出；使用用户身份卡、读卡器和识别接口卡等设备对本CSCI运行的计算机设备的开关机及软件启动等操作进行控制。数据库访问权限控制利用数据库管理系统，对不同的用户分配不同的角色，并对其进行可访问信息的范围和访问权限进行设置；对用户访问数据库的操作进行审计。其他CSCI级设计决策本条可针对本CSCI软件需求规格中的其它特殊需求（如：灵活性、可用性、可维护性等方面的需求），描述其相应的实现方法的设计原则。。对有特殊需求的CSCI要求必须填写，如为满足性能指标所进行的负载均衡设计、并行计算或高性能计算设计决策等。如果本节无内容，填写“无。”CSCI体系结构设计描述CSCI体系结构，明确包之间的依赖关系。图SEQ图\*ARABIC3CSCI体系结构图CSCI包汇总设计人员确定包的命名规则，确保软件设计文档的风格与代码的风格保持一致。可以从机构的编程规范中摘取或引用（如果存在的话）。另外，描述包的开发类型，包括新研、改进、完全重用、采购等。表SEQ表\*ARABIC3XX软件包汇总表序号标识名称说明开发类型PAK_MMI_XXPAK_MMI_XXPAK_MMI_XXPAK_MMI_XXPAK_MMI_XX……XX包设计功能说明描述包的主要功能。性能分配（可选）描述性能指标的在包中的分配情况。执行方案必须覆盖需求中的业务流程。注释：本阶段仅完成业务流程到包的设计即可。XX功能/业务流程说明简要描述完成该业务所牵涉到的包，即在该业务中包的功能。例如：完成XX功能，需要涉及到XX包、YY包。XX包主要负责XX，YY包主要负责XX。补充说明（可选）针对复杂度较高或者具有特殊性的业务功能。接口设计设计人员确定内外部接口的命名规则，确保软件设计文档的风格与代码的风格保持一致。可以从机构的编程规范中摘取或引用（如果存在的话）。外部接口描述CSCI外部包/组件间的接口信息，接口种类分成API接口、信息接口和数据库接口。使用图表的形式描述接口。图SEQ图\*ARABIC5外部接口示意图API接口设计表SEQ表\*ARABIC4API接口设计表序号实现方依赖方接口名称接口标识接口功能说明备注12信息接口设计表SEQ表\*ARABIC5信息接口设计表序号实现方依赖方接口名称接口标识接口功能说明备注12数据库接口设计表SEQ表\*ARABIC6信息接口设计表序号表名标识数据项写入方读取方备注1标识/密码2内部接口描述CSCI包/组件内部接口，即CSCI类之间接口关系。具体接口形式参见外部接口。下表是接口的详细设计，在不影响后续开展详细设计的情况下，在概要设计中为可选，并可在后续详细设计中体现或由接口协议文件代替。接口标识如：I/F-A-B-01,以此类推。使用说明对于通讯接口，必要时，在此说明通讯的协议、传输格式、数据传输率、周期或非周期等数据元素说明名称英文名称简短描述类型测量单位极限值/值域精确度精度／分辨率合法性检查经度I--1-检查是否大于0用户界面设计（可选）应当遵循的界面设计规范结合用户需求和组织相关规范，阐述本软件用户界面设计应当遵循的规范（原则、建议等）。可以从机构的编程规范中摘取或引用（如果存在的话）。界面信息汇总表SEQ表\*ARABIC7XX软件界面汇总表标识号（XX主界面）序号标识名称说明备注子界面标识XX主要完成XX功能。……标识号（XX主界面）序号标识名称说明备注子界面标识XX主要完成XX功能。……界面视图XX主界面绘制主界面的视图，并简要介绍。XX子界面绘制子界面的视图，并简要介绍。XY主界面绘制主界面的视图，并简要介绍。XX子界面绘制子界面的视图，并简要介绍。……人因设计（可选）（1）阐述界面的布局及理由；（2）阐述界面的色彩及理由。界面资源设计（可选）图标资源图像资源界面组件数据（库）结构设计（可选）从永久性数据存储方面来对系统进行说明。如果几乎或根本没有永久性数据，或者设计模型与数据模型之间的转换并不重要，那么本节就为可选。注：如果需要可以单独形成《数据库设计说明》，此处可以直接应用该文档。逻辑结构设计要点给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。图SEQ图\*ARABIC6数据库逻辑结构图表SEQ表\*ARABIC8XX表字段结构序号字段名称字段标识字段类型长度主键外键非空注释是/否是/否是/否默认值等物理结构设计要点给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（数据库实例、表空间、表权限）、设计考虑和保密条件。配置文件设计（若有）对本CSCI软件使用的所有配置文件进行设计，包括配置文件的格式及配置项的说明（可用表格形式列出）。XX配置文件XX配置文件部署设计本节用来说明运行软件的两种部署设计，其中包括设计部署和物理部署两部分。设计部署用于说明设计过程与软件实体的对应关系，物理部署用于说明软件实体与物理台位间的映射关系，对于每种配置，至少应该指出执行该软件的物理节点（计算机、CPU）及其互连情况（总线连接、LAN连接、点到点连接等）。注：如果软件的部署一目了然，那么本节就为可选。设计部署表SEQ表\*ARABIC9XX软件设计部署表序号软件实体设计包备用1xx.oxx包2xx.dllxx包3xx.exexx包物理部署图SEQ图\*ARABIC7XX软件物理部署图表SEQ表\*ARABIC10XX软件物理