信息技术有限公司系统设计报告编写规范(1)

系统设计报告编写规范文件编号：NW506101生效日期：2004-2-20受控编号：密级：秘密版次：Ver1.0修改状态：总页数19正文4附录15编制：张俊岭、郑泽梅审核：批准：中科海鑫信息技术有限公司（版权所有，翻版必究）系统设计报告编写规范Ver1.0P-2/4中科海鑫信息技术有限公司文件修改控制修改记录编号修改状态修改页码及条款修改人审核人批准人修改日期系统设计报告编写规范Ver1.0P-3/4中科海鑫信息技术有限公司目录1.目的2.适用范围3.术语及缩略语4.编写规范4.1排版规范4.2模板使用5.引用文件6.附录系统设计报告编写规范Ver1.0P-4/4中科海鑫信息技术有限公司1.目的系统设计报告主要为使软件产品和软件项目满足规定的软件规格要求而确定软件系统的体系结构、组成成分、数据组织、模块、内外部接口。主要任务有：1)建立软件产品和软件项目目标系统的总体结构。对于大规模软件系统，应分为若干子系统，在本报告中只说明总体设计，然后为每个子系统编写《系统设计报告》；2)总体设计；3)模块设计；4)涉及使用数据库的设计需编写数据库设计。2.适用范围适用于软件开发设计阶段的《系统设计报告》的编写。3.术语及缩略语本程序采用NQ402100《质量手册》中的术语和缩略语及其定义。4.编写规范4.1排版规范1）整个规范由2节构成，模板单独一节。2）正文样式采用“规范正文”。3）标题编号采用每节独立编号。4.2模板使用系统设计报告的编写可依据具体情况选用摸板的格式或编写指南的格式。1）拷贝规范。2）删除第一节（系统设计报告封面前的所有页）。3）在修改完内容后，更新目录域和相关的页数域。5.引用文件(无)6.附录以下部分为系统设计报告的模板与编写指南。密级：机密文档编号：第版分册名称：第册/共册项目名称（项目编号）系统设计报告（部门名称）中科海鑫信息技术有限公司总页数正文附录生效日期：年月日编制：审核：批准：系统设计报告2/5中科海鑫信息技术有限公司目录1.引言.................................................................................................................................................11.1目的........................................................................................................................................11.2背景........................................................................................................................................11.3术语........................................................................................................................................11.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.故障处理说明.................................................................................................................................25.数据库设计.....................................................................................................................................25.1数据字典设计........................................................................................................................25.2安全保密设计........................................................................................................................2系统设计报告3/5中科海鑫信息技术有限公司1.引言1.1目的说明编写本《系统设计说明书》的目的。1.2背景：说明理解本报告所需的背景，如与公司其它软件之间的联系等。1.3术语列出本系统设计说明书中专门术语的定义和英文缩写词的原词组。1.4参考资料：列出编写参考的文件、资料、技术标准以及他们的作者、标题、编号、发布日期和出版单位。编号资料名称简介作者日期出版单位列出编写本报告时需查阅的Internet上杂志、专业著作、技术标准以及他们的网址。网点简介2.总体设计2.1系统运行环境给出本软件系统运行所需的基本软/硬件环境、使用本软件系统典型用户的设备分布图及设备上相应软件配置。软件环境包括：操作系统、数据库、以及其它支撑软件；硬件环境包括：主机类型、网络类型、存储器容量、其它特殊设备。2.2软件功能描述描述被开发软件的功能，如有同等作用的文件（如已编写的《软件功能规格说明书》）则可直接在此引述该文件名及归档的部门即可。2.3软件结构以图表形式给出软件子系统结构和模块组成结构。凡单独编写《系统设计报告》的子系统，其内部自用的模块不必列出。2.4技术路线给出本软件系统在实现过程中所采用的技术路线、方法。对比较新的技术给予详细的阐述及必要的说明，在可能的情况下给出相应的技术参考资料。系统设计报告4/5中科海鑫信息技术有限公司2.5外部接口2.5.1用户接口描述该软件与用户的接口，包括用户输入输出界面样式、操作方式和界面间的转移关系。如具有等同作用的文件（如使用开发工具编写的界面原型程序等），本处仅需列出该文件名、保管部门即可。2.5.2软件接口描述该软件与其它系统的软件接口，主要说明其它系统提供的编程接口和本系统向其它系统提供的编程接口，如具有等同作用的文件（如包含接口说明及注释的源文件程序头文件、接口帮助的超文本文件等），本处仅需列出该文件名、保管部门即可。2.5.3其它接口描述该软件与其它系统的其它类型接口，主要说明其它系统提供的和本系统向其它系统提供的硬件接口、通信协议及规程、数据交换格式等，如具有等同作用的文件，本处仅需列出该文件名、保管部门即可。3.模块设计3.1功能简述各模块的功能。3.2性能说明对各模块的性能要求，包括精度、时间特性和处理速度。3.3内部接口说明各模块之间接口，包括：1)各模块的用途、使用(调用)方式；2)说明其每个子程序（方法，Method）、特性（Proper