《某信息技术公司系统设计报告编写规范》由会员分享，可在线阅读，更多相关《某信息技术公司系统设计报告编写规范（19页珍藏版）》请在金锄头文库上搜索。
1、系统设计报告编写规范 Ver1.0 P-2/4系统设计计报告编编写规范范文件编号号： NW55061101 生效日期期：20044-2-20受控编号号：密级：秘秘密版次：VVer11.0修改状态态：总页数19正文4附录15编制：张张俊岭、郑郑泽梅审核：批准：中科海鑫鑫信息技技术有限限公司（版权所所有，翻翻版必究究）文件修改改控制修改记录录编号修改状态修改页码码及条款款修改人审核人批准人修改日期期目录1. 目的2. 适用范范围3. 术语及及缩略语语4.编写写规范4.1排排版规范范4.2模模板使用用5.引用用文件6. 附录1. 目的系统设计计报告主主要为使软件件产品和和软件项项目满足足规定的的软件
2、规规格要求求而确定定软件系系统的体体系结构构、组成成成分、数数据组织织、模块块、内外外部接口口。主要要任务有有：1) 建立软件件产品和和软件项项目目标标系统的的总体结结构。对对于大规规模软件件系统，应应分为若若干子系系统，在在本报告告中只说说明总体体设计，然然后为每每个子系系统编写写系统统设计报报告；2) 总体设计计；3) 模块设计计；4) 涉及使用用数据库库的设计计需编写写数据库库设计。2. 适用范围围适用于软软件开发发设计阶阶段的系系统设计计报告的的编写。3. 术语及缩缩略语本程序采采用NQQ40221000质量量手册中中的术语语和缩略略语及其其定义。4. 编写规范范4.1 排版规范范1）
3、 整个规范范由2节构成成，模板板单独一一节。2） 正文样式式采用“规范正正文”。3） 标题编号号采用每每节独立立编号。4.2 模板使用用系统设计计报告的的编写可可依据具具体情况况选用摸摸板的格格式或编编写指南南的格式式。1） 拷贝规范范。2） 删除第一一节（系系统设计计报告封封面前的的所有页页）。3） 在修改完完内容后后，更新新目录域域和相关关的页数数域。5. 引用文件件(无)6. 附录以下部分分为系统统设计报报告的模模板与编编写指南南。中科海鑫信息技术有限公司系统设计报告2/5密级：机机密文档编号号：第版分册名称称：第册/共册项目名称称（项目目编号）系统设计计报告（部门名名称）中科海鑫鑫信息
4、技技术有限限公司总页数正文附录生效日期期：年月日编制：审核：批准：目录1. 引引言1.1 目的1.2 背景1.3 术语1.4 参考资资料2. 总总体设计计2.1 系统运运行环境境2.2 软件功功能描述述2.3 软件结结构2.4 技术路路线2.5 外部接接口2.5.1 用用户接口口2.5.2 软软件接口口2.5.3 其其它接口口3. 模模块设计计3.1 功能3.2 性能3.3 内部接接口3.4 外部存存贮结构构设计4. 故故障处理理说明5. 数数据库设设计5.1 数据字字典设计计5.2 安全保保密设计计中科海鑫信息技术有限公司系统设计报告4/51.引引言1.1目的说明编写写本系系统设计计说明书书
5、的目目的。1.2背景：说明理解解本报告告所需的的背景，如如与公司司其它软软件之间间的联系系等。1.3术语列出本系系统设计计说明书书中专门门术语的的定义和和英文缩缩写词的的原词组组。1.4参考资资料：列出编写写参考的的文件、资资料、技技术标准准以及他他们的作作者、标标题、编编号、发发布日期期和出版版单位。编号资料名称称简介作者日期出版单位位列出编写写本报告告时需查查阅的IInteenettIntternnet上上杂志、专专业著作作、技术术标准以以及他们们的网址址。网点简介2. 总体设计计2.1 系统运行行环境给出本软软件系统统运行所所需的基基本软/硬件环环境、使使用本软软件系统统典型用用户的设设
6、备分布布图及设设备上相相应软件件配置。软软件环境境包括：操作系系统、数数据库、以以及其它它支撑软软件；硬硬件环境境包括：主机类类型、网网络类型型、存储储器容量量、其它它特殊设设备。2.2 软件功能能描述描述被开开发软件件的功能能，如有有同等作作用的文文件（如如已编写写的软软件功能能规格说说明书）则则可直接接在此引引述该文文件名及及归档的的部门即即可。2.3 软件结构构以图表形形式给出出软件子子系统结结构和模模块组成成结构。凡凡单独编编写系系统设计计报告的的子系统统，其内内部自用用的模块块不必列列出。2.4 技术路线线给出本软软件系统统在实现现过程中中所采用用的技术术路线、方方法。对对比较新新的
7、技术术给予详详细的阐阐述及必必要的说说明，在在可能的的情况下下给出相相应的技技术参考考资料。2.5 外部接口口2.5.1 用户接口口描述该软软件与用用户的接接口，包包括用户户输入输输出界面面样式、操操作方式式和界面面间的转转移关系系。如具具有等同同作用的的文件（如如使用开开发工具具编写的的界面原原型程序序等），本本处仅需需列出该该文件名名、保管管部门即即可。2.5.2 软件接口口描述该软软件与其其它系统统的软件件接口，主主要说明明其它系系统提供供的编程程接口和和本系统统向其它它系统提提供的编编程接口口，如具具有等同同作用的的文件（如如包含接接口说明明及注释释的源文文件程序序头文件件、接口口帮助
8、的的超文本本文件等等），本本处仅需需列出该该文件名名、保管管部门即即可。2.5.3 其它接口口描述该软软件与其其它系统统的其它它类型接接口，主主要说明明其它系系统提供供的和本本系统向向其它系系统提供供的硬件件接口、通通信协议议及规程程、数据据交换格格式等，如如具有等等同作用用的文件件，本处处仅需列列出该文文件名、保保管部门门即可。3. 模块设计计3.1 功能简述各模模块的功功能。3.2 性能说明对各各模块的的性能要要求，包包括精度度、时间间特性和和处理速速度。3.3 内部接口口说明各模模块之间间接口，包包括：1) 各模块的的用途、使使用(调用)方式；2) 说明其每每个子程程序（方方法，MMet
9、hhod）、特特性（PProppertty）和和反馈的的事件（Event），相应的输入、输出项说明；3) 指明各模模块内含含的各类类外部接接口，并并列出这这些外部部接口说说明材料料名。3.4 外部存贮贮结构设设计说明本系系统存贮贮于磁盘盘等持久久性存贮贮介质，而而且不是是由数据据库管理理系统进进行管理理的数据据的组织织结构，包包括数据据名称、用用途、每每个数据据项的标标识名、类类型和含含义，组组织结构构、访问问方法和和存储要要求。系统设计报告5/54. 故障处理理说明说明本系系统所采采用的基基本错误误处理方方法和原原则，例例如：统统一采用用C+ trry-ccatcch错误误方法，所所有错误误
10、最终必必须以界界面形式式向用户户说明。用用一览表表方式说说明各类类可能的的错误或或故障出出现时系系统的处处理方法法和补救救措施。5. 数据库设设计5.1 数据字典典设计对数据库库设计中中涉及到到的各种种项目，如如数据项项、记录录、表、数数据库等等建立数数据字典典，以说说明它们们的标识识符、同同义名及及有关信信息，并并说明对对此数据据字典设设计的基基本考虑虑。凡采采用数据据库设计计工具（如如ER图设设计工具具）生成成的数据据字典，本本处仅需需列出对对应的文文件名、保保管部门门即可。5.2 安全保密密设计说明在数数据库的的设计中中，如何何通过区区分不同同的访问问者、不不同的访访问类型型和不同同的数
11、据据对象，进进行分别别对待而而获得的的数据库库安全保保密设计计考虑。系统设计报告编写指南系统设计计报告编编写指南南之一1.IIntrroduuctiion介介绍l 描述这个个文档的的编写目目的；l 描述这个个文档的的适用范范围；l 描述这个个文档的的读者；l 确定这个个系统/产品的的名称和和/或版本本号；l 定义重要要的术语语、缩写写词或缩缩略语；l 总结（或或给出一一个概要要）这个个文档的的内容。2.SSysttem Oveerviiew系系统概述述对软件系系统的一一般性描描述，包包括系统统的功能能和其他他与设计计相关的的内容。3.DDesiign Connsidderaatioons设设计
12、上的的考虑本节描述述在完成成一个完完整的设设计解决决方案之之前必须须阐明或或解决的的问题。3.1AAssuumpttionns aand Deppenddencciess假设和和依赖l 相关的软软件和硬硬件l 操作系统统l 最终用户户特征l 在功能上上可能发发生的变变化3.2GGeneerall Coonsttraiintss一般限限制l 描述对软软件系统统的设计计有重要要影响的的全局限限制或约约束。l 硬件或软软件环境境；l 最终用户户环境；l 资源的可可用性和和挥发性性；l 标准的兼兼容；(opttionn)l 协同工作作的要求求；l 接口/协协议的要要求；l 数据储存存和发布布要求；l
13、安全性的的要求（或或其它类类似的规规则）；l 内存和其其它的容容量限制制；l 性能要求求；l 网络通信信；(ooptiion)l 验证和确确认的要要求（测测试）；l 其他质量量目标的的要求；l 在需求分分析说明明书中所所描述的的其它要要求。3.3 Goaals andd Guuideelinnes目目标和指指导方针针描述所有有支配软软件系统统设计的的目标、指指导方针针、原则则或者优优先权。l 尽量保持持它简单单易用；l 强调速度度与内存存使用的的矛盾；l 象像对待待一个已已经存在在的产品品那样工工作、观观察或者者体会。3.4 Devveloopmeent Metthodds开发发方法简要地描描述用于于软件设设计的方方法。如如果采用用正式/已公布布的方法法，那么么就要对对这些方方法进行行详细描描述，同同时还要要简单解解释一下下为什么么采用这这个方法法或其中中的某些些部分。4.AArchhiteectuurall Sttrattegiies体体系结构构策略描述所有有影响整整个系统统的组织织和结构构的设计计决定和和/或策略略，这些些策略深深入描述述系统体体系结构构所使用用的关键键技术和和机制。对对于每个个设计决决定
