某信息技术公司系统设计报告编写规范.docx

《某信息技术公司系统设计报告编写规范.docx》由会员分享，可在线阅读，更多相关《某信息技术公司系统设计报告编写规范.docx（21页珍藏版）》请在第一文库网上搜索。

1、某信息技术公司系统设计报告编写规范系统设计报告编写规范文件编号：NW506101生效日期：2004-2-20受控编号：密级：秘密版次:Ver1.0修改状态：总页数19正文4附录15编制：张俊岭、郑泽梅批准：中科海鑫信息技术有限公司（版权所有，翻版必究）文件修改操纵修改记录编号修改状态修改页码及条款修改人审核人批准人修改日期目录1 .目的2 .适用范围3 .术语及缩略语4 .编写规范4.1 排版规范4.2 模板使用5 .引用文件6 .附录1 .目的系统设计报告要紧为使软件产品与软件项目满足规定的软件规格要求而确定软件系统的体系结构、构成成分、数据组织、模块、内外部接口。要紧任务有：1）建立软件产

2、品与软件项目目标系统的总体结构。关于大规模软件系统，应分为若干子系统，在本报告中只说明总体设计，然后为每个子系统编写系统设计报告；2）总体设计；3）模块设计；4）涉及使用数据库的设计需编写数据库设计。2 .适用范围适用于软件开发设计阶段的系统设计报告的编写。3 .术语及缩略语本程序使用NQ402100质量手册中的术语与缩略语及其定义。4 .编写规范4.1 排版规范1）整个规范由2节构成，模板单独一节。2）正文样式使用“规范正文”。3）标题编号使用每节独立编号。4.2 模板使用系统设计报告的编写可根据具体情况选用摸板的格式或者编写指南的格式。1）拷贝规范。2）删除第一节（系统设计报告封面前的所有

3、页）。3）在修改完内容后，更新目录域与有关的页数域。5 .引用文件（无）6 .附录下列部分为系统设计报告的模板与编写指南。密级：机密第版第册/共册文档编号：分册名称：项目名称（项目编号）系统设计报告（部门名称）中科海鑫信息技术有限公司总页数正文附录生效日期：年月日编制：批准：目录1 .弓I言11 212 .4参考资料12 .总体设计12.1 系统运彳丁环境12.2 软件功能描述12.3 软件结构12.4 技术路线12.5 外部接口22.5.1 用户接口22.5.2 软件接口22.5.3 其它接口23 .模块设计23.1 功能23.2 性能23.3 内部接口23.4 外部存贮结构设计24 .故障

4、处理说明25 .数据库设计25.1 数据字典设计25.2 安全保密设计21 .引言1.1 目的说明编写本系统设计说明书的目的。1.2 背景：说明懂得本报告所需的背景，如与公司其它软件之间的联系等。1.3 术语列出本系统设计说明书中专门术语的定义与英文缩写词的原词组。1.4 参考资料：列出编写参考的文件、资料、技术标准与他们的作者、标题、编号、公布日期与出版单位。编号资料名称简介作者日期出版单位列出编写本报告时需查阅的gefie1也迎上杂志、专业著作、技术标准与他们的网址。网点简介2 .总体设计2.1 系统运行环境给出本软件系统运行所需的基本软/硬件环境、使用本软件系统典型用户的设备分布图及设备

5、上相应软件配置。软件环境包含：操作系统、数据库、与其它支撑软件；硬件环境包含：主机类型、网络类型、存储器容量、其它特殊设备。2.2 软件功能描述描述被开发软件的功能，如有同等作用的文件（如已编写的软件功能规格说明书）则可直接在此引述该文件名及归档的部门即可。2.3 软件结构以图表形式给出软件子系统结构与模块构成结构。凡单独编写系统设计报告的子系统，其内部自用的模块不必列出。2.4 技术路线给出本软件系统在实现过程中所使用的技术路线、方法。对比较新的技术给予全面的阐述及必要的说明，在可能的情况下给出相应的技术参考资料。2.5 外部接口2.5.1 用户接口描述该软件与用户的接口，包含用户输入输出界

6、面样式、操作方式与界面间的转移关系。如具有等同作用的文件（如使用开发工具编写的界面原型程序等），本处仅需列出该文件名、保管部门即可。252软件接口描述该软件与其它系统的软件接口，要紧说明其它系统提供的编程接口与本系统向其它系统提供的编程接口，如具有等同作用的文件（如包含接口说明及注释的源文件程序头文件、接口帮助的超文本文件等），本处仅需列出该文件名、保管部门即可。253其它接口描述该软件与其它系统的其它类型接口，要紧说明其它系统提供的与本系统向其它系统提供的硬件接口、通信协议及规程、数据交换格式等，如具有等同作用的文件，本处仅需列出该文件名、保管部门即可。3 .模块设计3.1 功能简述各模块的

7、功能。3.2 性能说明对各模块的性能要求，包含精度、时间特性与处理速度。3.3 内部接口说明各模块之间接口，包含：1）各模块的用途、使用（调用）方式；2）说明其每个子程序（方法，Method）特性（ProPerty）与反馈的事件（EVent）,相应的输入、输出项说明；3）指明各模块内含的各类外部接口，并列出这些外部接口说明材料名。3.4 外部存贮结构设计说明本系统存贮于磁盘等持久性存贮介质，而且不是由数据库管理系统进行管理的数据的组织结构，包含数据名称、用途、每个数据项的标识名、类型与含义，组织结构、访问方法与存储要求。4 .故障处理说明说明本系统所使用的基本错误处理方法与原则，比如：统一使用

8、C+try-catch错误方法,所有错误最终务必以界面形式向用户说明。用一览表方式说明各类可能的错误或者故障出现时系统的处理方法与补救措施。5 .数据库设计5.1 数据字典设计对数据库设计中涉及到的各类项目，如数据项、记录、表、数据库等建立数据字典，以说明它们的标识符、同义名及有关信息，并说明对此数据字典设计的基本考虑。凡使用数据库设计工具（如ER图设计工具）生成的数据字典，本处仅需列出对应的文件名、保管部门即可。5.2 安全保密设计说明在数据库的设计中，如何通过区分不一致的访问者、不一致的访问类型与不一致的数据对象，进行分别对待而获得的数据库安全保密设计考虑。1. IntrOdUCtion介

9、绍 描述这个文档的编写目的； 描述这个文档的适用范围； 描述这个文档的读者； 确定这个系统/产品的名称与/或者版本号； 定义重要的术语、缩写词或者缩略语； 总结（或者给出一个概要）这个文档的内容。2. SystemOverview系统概述对软件系统的通常性描述，包含系统的功能与其他与设计有关的内容。3. DesignConsiderations设计上的考虑本节描述在完成一个完整的设计解决方案之前务必阐明或者解决的问题。3.1 AssumptionsandDependencies假设与依靠 有关的软件与硬件 操作系统 最终用户特征 在功能上可能发生的变化3.2 Genera1COnStraint

10、S通常限制 描述对软件系统的设计有重要影响的全局限制或者约束。 硬件或者软件环境； 最终用户环境； 资源的可用性与挥发性； 标准的兼容；（OPtion） 协同工作的要求； 接口/协议的要求； 数据储存与公布要求； 安全性的要求（或者其它类似的规则）； 内存与其它的容量限制； 性能要求； 网络通信；（OPtiOn） 验证与确认的要求（测试）； 其他质量目标的要求； 在需求分析说明书中所描述的其它要求。3.3 Goa1sandGuide1ines目标与指导方针描述所有支配软件系统设计的目标、指导方针、原则或者者优先权。 尽量保持它简单易用； 强调速度与内存使用的矛盾； 象像对待一个已经存在的产品那

11、样工作、观察或者者体会。3.4 Deve1opmentMethods开发方法简要地描述用于软件设计的方法。假如使用正式/已公布的方法，那么就要对这些方法进行全面描述，同时还要简单解释一下为什么使用这个方法或者其中的某些部分。4. Architectura1Strategies体系结构策略描述所有影响整个系统的组织与结构的设计决定与/或者策略，这些策略深入描述系统体系结构所使用的关键技术与机制。关于每个设计决定与/或者策略都要描述其产生原因（可能要引用前面阐述的设计目标与原则），与它们是如何得到均衡与折中的，涉及内容： 使用特定类型产品（编程语言、数据库、函数库等）； 重用现有组件； 软件未来扩

12、展与升级的计划； 用户接口模型（或者系统的输入与输出模型）； 硬件或者软件接口模型； 错误检测与恢复； 内存管理策略； 外部数据库与/或者数据存储管理与保护； 网络上分布式数据或者操纵； 操纵的通常方法； 并发与同步； 通信机制； 其它资源的管理。每一个被使用的重要战略务必在相应的子章节内加以讨论。5. SystemArchitecture系统体系结构在本节应该在一个较高的层次来说明如何将系统的功能划分给各个子系统或者组件，不要涉及这些组件本身的细节（后面有一个小节专门来全面描述组件）。本节的要紧目标是描述系统是如何进行分解、这样分解的原因与各部分是如何协作工作以完成预定功能。在较高的层次上描

13、述系统所要承担的要紧工作责任、系统所扮演的各类角色；描述如何将系统划分成各个组件/子系统，每个组件/子系统的作用是什么；描述高层组件之间是如何协调工作已完成预期的功能；进行系统分解时所使用的基本原则；能够使用图表、模型、流程图等形式来描述上述内容。5.1 SubsystemArchitecture子系统的体系结构建立一个子章节来全面描述某一组件的作用，进一步描述该组件是如何分为子组件的与各个子组件之间的关系。6. Po1iciesandTactics政策与实施策略描述影响系统的接口细节与系统实现细节的各个方面： 选择特定产品来使用（如编译器、解释器、数据库、函数库等）； 工程上的折中； 编码规

14、范与惯例； 一个或者多个子系统、模块或者子程序的协议； 选择某一特定算法或者编程用语来实现系统的一部分； 功能性说明； 保证需求可回溯性的计划； 软件测试计划； 软件保护计划； 最终用户、软件、硬件与通信的接口； 将源代码按照物理形态（文件与路径）进行分层组织； 如何构造与/或者产生系统的交付物（如何编译、链接、加载等）。以上各项内容务必有相应的子章节进行讨论。假如还有其他方案可供选择时，要说明你没有选择这些方案的原因。能够使用图表、模型、流程图等形式来描述上述内容。7. Detai1edSystemDesign全面设计在系统体系结构中所描述的绝大多数组件需要在本章节进行更深一步的讨论，同样，其它低层的组件与子组件也需要描述。为每个组件建立一个子章节来全面描述组件，包含下列内容： C1assification分类组件的种类，比如是一个子系统、模块、类、包、函数、文件等