2概要设计说明书编写规范

《2概要设计说明书编写规范》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、案卷号日期vxx集团网络化运营系统〉概要设计说明书修改情况记录:版本号修改批准人修改人安装FI期签收人1、首页主要检查排版是否美观、整齐；是否有编写日期；文档名称和文件命名是否一致;是否显示页码；项目名称是否正确。目录1引言11.1编写目的11.2范围11.3定义11.4参考资料12总体设计22」需求规定22.2运行环境22.3基本设计概念和处理流程22.4结构22.5功能需求与程丿芋的关系32.6人工处理过程32.7尚未解决的问题33接口设计43.1用户接口43.2外部接口43.3内部接口44运行设计44」运行模块组合44.2运行控制44.3运行时

2、间55系统数据结构设计55」逻辑结构设计要点55.2物理结构设计要点55.3数据结构与程序的关系56系统出错处理设计66.1出错信息66.2补救措施66.3系统维护设计62、主要是看页码显示是否正确、对齐；目录编号是否正确或者有缺漏；如果没有目录，作为完成的文档，必须补上目录；是否也显示了页码，一般上不需要；目录的结构是否合理。目录的主要部分：引言、总体设计、接口设计、运行设计、数据结构设计以及出错处理设计是否齐全。1引言1.1编写目的服务于XX集团网络化运营，管理销售中的各个环节，最终用户为XX集团销售公司,销售办事处和集团领导。3、将概要设计编写

3、的目的写明白，是为了认识整个系统的架构，为下一步详细设计奠定基础，指出预期读者，审核重点关注内容的描述是否正确。1.2范围说明：a.待开发的软件系统的名称；b.列出本项冃的任务提出者、开发者、用户以及将运行该项软件的单位。4、从大的背景角度说明软件的设计范围，这里的内容可以粗一点。1.3定义列出本文件中川到的专门术语的定义和缩写词的原词组。5、对特别的词做相应的说明，特别是有区别与一般语义的词，或者是项目中重点的词。这里重点审查词的说明性定义是否正确，是否符合项目的建设定义。1.4参考资料列出耍用到的参考资料，如：a.本项目的经核准的计划任务巧或合同

4、、上级机关的批文；b.属于本项目的其他已发表的文件；c.本文件小各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表FI期和出版单位，说明能够得到这些文件资料的来源。6、上级下发的文件，相关的规范标准，招投标文件，需求规格说明书、业务制度规范等都可以在这里列出。重点审核文件名是否正确，文件是否存在。重点审核需求规格说明书是否已经列进来，这是必须的。2总体设计2.1需求规定说明对本系统的主耍的输入输出项目、处理的功能性能要求，详细的说明可参见《需求分析说明书》。7、从需求的角度做相应的描述，这方面的内容不能少，一般建议通

5、过系统总结构图的方式描述系统的总需求。并分别列出功能的大模块的需求，包括性能需求。2.2运行环:*=1简要地说明对木系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见《需求分析说明书》。8、运行环境包括硬件和软件的运行环境，重点审核环境参数和招投书和实际的客户要求的环境参数是否一致。23基本设计概念和处理流程说明本系统的基木设计概念和处理流程，尽虽使用图表的形式。9、通过图文结合的方式描述系统的设计概念和流程，重点审核内容是否包括了整个系统，数据流程是否正确。2.4结构川一览表及框图的形式说明本系统的系统元索（各层模块、子程序、公用程序等）

6、的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。10、这里也采用图文结合的方式，描述系统的功能、结构要素，重点审核结构图是否正确,文字描述是否得当，是否包括了整个系统的内容。2.5功能需求与程序的关系木条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系:程序1程序2程序m功能盂求1V功能需求2V功能需求nVV11、这是一个关键表，审核时候建议必须要有，很多概要设计说明书忽略这里，因为相对来说不好整理。这里说明了需求和程序设计之间的关联，可以从一个表格就能看得清楚。2.6人工处理过程说明在本软件系统的工

7、作过程中不得不包含的人工处理过程（如果有的话）。12、这部分内容不是必须，如果有人工需要处理的过程，建议还是要有这些内容。审核内容是否正确。2.7尚未解决的问题说明在概要设计过程屮尚未解决而设计者认为在系统完成之前必须解决的各个问题。13、这也不是必须的内容，如果有这方面的内容就补充，审核它的正确性，如果没有，建议保留目录。3接口设计3.1用户接口说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。3.2外部接口说明木系统同外界的所有接口的安排包括软件与硬件之间的接口、木系统与各支持软件之间的接口关系。3.3内部接口说明本系统之内的各个系统元

8、素之间的接口的安排。14、三个接口设计是概要设计的不可少的部分，特别是外部接口，是关联其他系统的设计,关系到