系统设计报告编写规范东大阿尔派软件公司(编辑修改稿)内容摘要:
技术给予详细的阐述及必要的说明,在可能的情况下给出相应的技术参考资料。 系统设计报告 4/5 沈阳东大阿尔派软件股份有限公司 外部接口 描述该软件与用户的接口,包括用户输入输出界面样式、操作方式和界面间的转移关系。 如具有等同作用的文件(如使用开发工具编写的界面原型程序等),本处仅需列出该文件名、保管部门即可。 描述该软件与其它系统的软件接口,主要说明其它系统提供的编程接口和本系统向其它系统提供的编程接口,如具有等同作用的文件(如包含接口说明及注释的源文件程序头文件、接口帮助的超文本文件 等),本处仅需列出该文件名、保管部门即可。 描述该软件与其它系统的其它类型接口,主要说明其它系统提供的和本系统向其它系统提供的硬件接口、通信协议及规程、数据交换格式等,如具有等同作用的文件,本处仅需列出该文件名、保管部门即可。 3. 模块设计 功能 简述各模块的功能。 性能 说明对各模块的性能要求,包括精度、时间特性和处理速度。 内部接口 说明各模块之间接口,包括: 1) 各模块的用途、使用 (调用 )方式; 2) 说明其每个子程序(方法, Method)、特性( Property)和反馈的事件( Event),相应的输入 、输出项说明; 3) 指明各模块内含的各类外部接口,并列出这些外部接口说明材料名。 外部存贮结构设计 说明本系统存贮于磁盘等持久性存贮介质,而且不是由数据库管理系统进行管理的数据的组织结构,包括数据名称、用途、每个数据项的标识名、类型和含义,组织结构、访问方法和存储要求。 系统设计报告 5/5 沈阳东大阿尔派软件股份有限公司 4. 故障处理说明 说明本系统所采用的基本错误处理方法和原则,例如:统一采用 C++ trycatch 错误方法,所有错误最终必须以界面形式向用户说明。 用一览表方式说明各类可能的错误或故障出现时系统的处理方法和补救措施。 5. 数据库设计 数据字典设计 对数据库设计中涉及到的各种项目,如数据项、记录、表、数据库等建立数据字典,以说明它们的标识符、同义名及有关信息,并说明对此数据字典设计的基本考虑。 凡采用数据库设计工具(如 ER 图设计工具)生成的数据字典,本处仅需列出对应的文件名、保管部门即可。 安全保密设计 说明在数据库的设计中,如何通过区分不同的访问者、不同的访问类型和不同的数据对象,进行分别对待而获得的数据库安全保密设计考虑。 系统设计报告编写指南 沈阳东大阿尔派软件股份有限公司 系统设计报告编写指南之一 1. Introduction 介绍 描述这个文档的编写目的; 描述这个文档的适用范围; 描述这 个文档的读者; 确定这个系统 /产品的名称和 /或版本号; 定义重要的术语、缩写词或缩略语; 总结(或给出一个概要)这个文档的内容。 2. System Overview 系统概述 对软件系统的一般性描述,包括系统的功能和其他与设计相关的内容。 3. Design Considerations 设计上的考虑 本节描述在完成一个完整的设计解决方案之前必须阐明或解决的问题。 Assumptions and Dependencies 假设和依赖 相关的软件和硬件 操作系统 最终用户特征 在功能上可能发生的变化 General Constraints 一般限制 描述对软件系统的设计有重要影响的全局限制或约束。 硬件或软件环境; 最终用户环境; 资源的可用性和挥发性; 标准的兼容; (option) 协同工作的要求; 接口 /协议的要求; 数据储存和发布要求; 安全性的要求(或其它类似的规则); 系统设计报告编写指南 沈阳东大阿尔派软件股份有限公司 内存和其它的容量限制; 性能要求; 网络通信; (option) 验证和确认的要求(测试); 其他质量目标的要求; 在需求分析说明书中所描述的其它要求。 Goals and Guidelines 目标和指导方针 描述所有支配软件系统设计的目标、指导方针、原则或者优先权。 尽量保持它简单易用; 强调速度与内存使用的矛盾; 象对待一个已经存在的产品那样工作、观察或者体会。 Development Methods 开发方法 简要地描述用于软件设计的方法。 如果采用正式 /已公布的方法,那么就要对这些方法进行详细描述,同时还要简单解释一下为什么采用这个方法或其中的某些部分。 4. Architectural Strategies 体系结构策略 描述所有影响整个系统的组织和结构的设计决定和 /或策略,这些策略深入描述系统体 系结构所使用的关键技术和机制。 对于每个设计决定和 /或策略都要描述其产生原因(可能要引用前面阐述的设计目标和原则),以及它们是如何得到均衡和折中的,涉及内容: 使用特定类型产品(编程语言、数据库、函数库等); 重用现有组件; 软件未来扩展和升级的计划; 用户接口模型(或系统的输入和输出模型); 硬件或软件接口模型; 错误检测和恢复; 内存管理策略; 外部数据库和 /或数据存储管理和维护; 网络上分布式数据或控制; 控制的一般方法; 并发和同步; 通信机制; 系统设计报告编写指南 沈阳东大阿尔派软件股份有限公司 其它资源的管理。 每一个被采用的重要战略必须在相应的子 章节内加以讨论。 5. System Architecture 系统体系结构 在本节应该在一个较高的层次来说明如何将系统的功能划分给各个子系统或组件,不要涉及这些组件本身的细节(后面有一个小节专门来详细描述组件)。 本节的主要目标是描述系统是如何进行分解、这样分解的原因以及各部分是如何协作工作以完成预定功能。 在较高的层次上描述系统所要承担的主要工作责任、系统所扮演的各种。系统设计报告编写规范东大阿尔派软件公司(编辑修改稿)
阅读剩余 0%
本站所有文章资讯、展示的图片素材等内容均为注册用户上传(部分报媒/平媒内容转载自网络合作媒体),仅供学习参考。
用户通过本站上传、发布的任何内容的知识产权归属用户或原始著作权人所有。如有侵犯您的版权,请联系我们反馈本站将在三个工作日内改正。