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

某信息技术公司系统设计报告编写规范系统设计报告编写规范中科海鑫信息技术有限公司（版权所有，翻版必究）系统设计报告编写指南之一Introduction介绍描述这个文档的编写目的；描述这个文档的适用范围；描述这个文档的读者；确定这个系统/产品的名称与/或者版本号；定义重要的术语、缩写词或者缩略语；总结（或者给出一个概要）这个文档的内容SystemOverview系统概述对软件系统的通常性描述，包含系统的功能与其他与设计有关的内容DesignConsiderations设计上的考虑本节描述在完成一个完整的设计解决方案之前务必阐明或者解决的问题AssumptionsandDependencies假设与依靠有关的软件与硬件操作系统最终用户特征在功能上可能发生的变化GeneralConstraints通常限制描述对软件系统的设计有重要影响的全局限制或者约束硬件或者软件环境；最终用户环境；资源的可用性与挥发性；标准的兼容；（option）协同工作的要求；接口/协议的要求；数据储存与公布要求；安全性的要求（或者其它类似的规则）；内存与其它的容量限制；性能要求；网络通信；（option）验证与确认的要求（测试）；其他质量目标的要求；在需求分析说明书中所描述的其它要求GoalsandGuidelines目标与指导方针描述所有支配软件系统设计的目标、指导方针、原则或者者优先权尽量保持它简单易用；强调速度与内存使用的矛盾；象像对待一个已经存在的产品那样工作、观察或者者体会DevelopmentMethods开发方法简要地描述用于软件设计的方法假如使用正式/已公布的方法，那么就要对这些方法进行全面描述，同时还要简单解释一下为什么使用这个方法或者其中的某些部分ArchitecturalStrategies体系结构策略描述所有影响整个系统的组织与结构的设计决定与/或者策略，这些策略深入描述系统体系结构所使用的关键技术与机制o关于每个设计决定与/或者策略都要描述其产生原因（可能要引用前面阐述的设计目标与原则），与它们是如何得到均衡与折中的，涉及内容使用特定类型产品（编程语言、数据库、函数库等）；重用现有组件；软件未来扩展与升级的计划；用户接口模型（或者系统的输入与输出模型）；硬件或者软件接口模型；错误检测与恢复；内存管理策略；外部数据库与/或者数据存储管理与保护；网络上分布式数据或者操纵；操纵的通常方法；并发与同步；通信机制；其它资源的管理每一个被使用的重要战略务必在相应的子章节内加以讨论SystemArchitecture系统体系结构在本节应该在一个较高的层次来说明如何将系统的功能划分给各个子系统或者组件，不要涉及这些组件本身的细节（后面有一个小节专门来全面描述组件）本节的要紧目标是描述系统是如何进行分解、这样分解的原因与各部分是如何协作工作以完成预定功能在较高的层次上描述系统所要承担的要紧工作责任、系统所扮演的各类角色；描述如何将系统划分成各个组件/子系统，每个组件/子系统的作用是什么；描述高层组件之间是如何协调工作已完成预期的功能；进行系统分解时所使用的基本原则；能够使用图表、模型、流程图等形式来描述上述内容SubsystemArchitecture子系统的体系结构建立一个子章节来全面描述某一组件的作用，进一步描述该组件是如何分为子组件的与各个子组件之间的关系PoliciesandTactics政策与实施策略描述影响系统的接口细节与系统实现细节的各个方面选择特定产品来使用（如编译器、解释器、数据库、函数库等）；工程上的折中；编码规范与惯例；一个或者多个子系统、模块或者子程序的协议；选择某一特定算法或者编程用语来实现系统的一部分；功能性说明；保证需求可回溯性的计划；软件测试计划；软件保护计划；最终用户、软件、硬件与通信的接口；将源代码按照物理形态（文件与路径）进行分层组织；如何构造与/或者产生系统的交付物（如何编译、链接、加载等）以上各项内容务必有相应的子章节进行讨论假如还有其他方案可供选择时，要说明你没有选择这些方案的原因能够使用图表、模型、流程图等形式来描述上述内容DetailedSystemDesign全面设计在系统体系结构中所描述的绝大多数组件需要在本章节进行更深一步的讨论，同样，其它低层的组件与子组件也需要描述为每个组件建立一个子章节来全面描述组件，包含下列内容Classification分类组件的种类，比如是一个子系统、模块、类、包、函数、文件等等Definition定义组件的确切用途与语义可能需要参照需求说明Responsibilities责任该组件的要紧责任与/或者行为，要完成什么？扮演什么角色？给客户提供哪写服务？可能需要参照需求说明Constraints约束与该组件有关的任何假设、限制、或者者约束，如时间、存储或者组件状态，还可能包含与该组件进行交互的规则（前提条件，后置条件，不变量，其它在输入与输出值、局部或者全局值上的限制，数据格式与数据存取，同步，例外等）Composition合成描述构成该组件的子组件及其用途Uses/Interactions用户/接口描述该组件与其它组件之间的关系，如该组件被什么组件所使用？该组件使用了什么其它组件？这关系到所使用的交互作用的方法面向对象的设计务必描述那些已知的与预期的子类、超类与元类Resources资源描述这个组件所管理的、影响的与使用的所有资源，如内存、处理器、打印机、数据库或者软件库，要描述可能存在的资源竞争、死锁等情况与相应的解决方案Processing过程描述该组件的执行过程，包含所使用的算法、状态的变化、有关的时间或者空间的复杂性、并发、创建方法、初始化、清除与例外情况的处理Interface/Exports界面/出口描述该组件所提供的服务，如资源、数据、类型、常量、子程序与例外等集合，明确定义每一个服务元素，即分类、定义、责任、约束、组合、使用、资源、处理与接口的描述.1DetailedSubsystemDesign全面子系统设计在本章节内对该组件进行更全面描述，可使用一些复杂的图表来显示组件结构、行为、或者者信息/操纵流Glossary词汇表列出在文档中所定义的术语与概念Bibliography参考书目一个参考书目与/或者有关出版物的列表系统设计报告编写指南之二Objectives目标描述系统设计报告的内容与目的Scope范围适用于指导包含设计阶段的项目编写系统设计报告References参考OutstandingIssues尚存要紧问题Approvals批准RD单位负责人Responsibilities职责开发部长对系统设计报告进行审核；项目管理部门组织对系统设计报告进行评审；设计人员提交符合本指南的系统设计报告设计人员对设计阶段的文档进行配置管理Template模板Introduction绪论•项目概述；•所设计的产品的概述SystemDescription系统描述SupportforRequirements对需求的支持•设计满足需求的程度；•设计未能完全满足的需求及其原因SystemPurpose系统目标简述所开发的系统，假如本系统同其他系统有不论是手工还是计算机方面的关系，也要描述可参考需求分析报告的内容InputsandOutputs输入与输出全面描述系统的所有输入与输出，包含界面设计、报表设计，参数格式Functions功能描述系统所提供的所有功能Storeddata数据存贮简述系统的数据文件Securityandbackup安全与备份系统在安全与备份方面的考虑与设计，包含回滚与恢复Exceptionhandling例外处理系统产生的所有错误信息的列表，包含错误发生的条件与所采取的措施所有例外情况的列表，与系统所采取的措施Impactassessment影响评估描述系统对现有环境的重要影响，如工序的变化，工作量的变化与硬件的变化能够参照需求分析报告的内容UserProcedures用户规程Systemnavigation系统导航描述那些使用户能充分使用系统的规则；Routine例程•描述在正常工作环境下，系统预期的使用方法；•使用流程图来描述例程，流程图要带有辅助描述，描述那些使用每个功能的用户的类型Exception例外处理描述系统在特殊情况下所使用的处理方式，如网络失效时的数据恢复Installation安装描述系统的安装过程Systemarchitecture系统结构Designprinciples设计原则描述系统设计所使用的策略，如用户界面的形式，所使用的标准产品等Designrationale设计原理•描述进行设计的根据，如数据库结构等；•模块调用原理是内部还是外部，是修改还是重建或者重用Softwarecomponentsandinterfaces软件组件与接口描述系统中的要紧组件，包含它们之间传递的包与数据流；数据流图与功能分解图；描述所引用的外部模块Capacityrequirements系统资源需求估计系统容量等需求的临界值，如内存、磁盘空间与、传输速率等Systemstructure系统结构描述系统的各模块是如何连接在一起工作的Data数据Definitions定义对系统中包含的所有数据项的描述Databasedesign数据库设计对逻辑数据库/文件设计的描述；对物理数据库/文件设计的描述；数据校验规则Calculations算法•定义系统所使用的计算或者算法；•确定实现这些算法的流程Datamanagementprocedures数据管理程序描述对系统数据的管理流程，如存档等Modulespecifications模块说明全面描述每个模块的逻辑、功能或者每个模块的所有状态、与其他模块的关联、状态的变迁、存在的条件及采取的动作；使用简洁、标准的语言；说明每个模块的输入与输出Physicalenvironment物理环境描述建立与运行系统所需要的物理环境Appendices附录•数据流图•数据模型系统设计报告检查表项目名称项目编号:总分:注1/1项，Yes（+6分），No（-6分）；其他各项，Yes（+1分），No（-l分）；不适用0分审核人/日期批准人/日期文件修改操纵.编写规范排版规范模板使用.引用文件.附录.目的系统设计报告要紧为使软件产品与软件项目满足规定的软件规格要求而确定软件系统的体系结构、构成成分、数据组织、模块、内外部接口要紧任务有1）建立软件产品与软件项目目标系统的总体结构关于大规模软件系统，应分为若干子系统，在本报告中只说明总体设计，然后为每个子系统编写《系统设计报告》；2）总体设计；3）模块设计；4）涉及使用数据库的设计需编写数据库设计.适用范围适用于软件开发设计阶段的《系统设计报告》的编写.术语及缩略语本程序使用NQ402100《质量手册》中的术语与缩略语及其定义.编写规范排版规范1）整个规范由2节构成，模板单独一节2）正文样式使用“规范正文”3）标题编号使用每节独立编号模板使用系统设计报告的编写可根据具体情况选用摸板的格式或者编写指南的格式1）拷贝规范2）删除第一节（系统设计报告封面前的所有页）3）在修改完内容后，更新目录域与有关的页数域.引用文件（无）.附录下列部分为系统设计报告的模板与编写指南密级机密文档编号分册名称项目名称（项目编号）系统设计报告（部门名称）中科海鑫信息技术有限公司总页数正文附录生效日期年月日编制:目录.弓I言1目的1背景1术语1参考资料

1.总体设计1系统运行环境1软件功能描述1软件结构1技术路线1夕卜部接口2用户接口2软件接口2其它接口

2.模块设计2功能2性能2内部接口2外部存贮结构设计

2.故障处理说明

2.数据库设计2数据字典设计2安全保密设计

2.引言目的说明编写本《系统设计说明书》的目的背景说明懂得本报告所需的背景，如与公司其它软件之间的联系等术语列出本系统设计说明书中专门术语的定义与英文缩写词的原词组参考资料列出编写参考的文件、资料、技术标准与他们的作者、标题、编号、公布日期与出版单位列出编写本报告时需查阅的WteRetlnl毁匣上杂志、专业著作、技术标准与他们的网址.总体设计系统运行环境给出本软件系统运行所需的基本软/硬件环境、使用本软件系统典型用户的设备分布图及设备上相应软件配置软件环境包含操作系统、数据库、与其它支撑软件；硬件环境包含主机类型、网络类型、存储器容量、其它特殊设备软件功能描述描述被开发软件的功能，如有同等作用的文件（如已编写的《软件功能规格说明书》）则可直接在此引述该文件名及归档的部门即可软件结构以图表形式给出软件子系统结构与模块构成结构凡单独编写《系统设计报告》的子系统，其内部自用的模块不必列出技术路线给出本软件系统在实现过程中所使用的技术路线、方法对比较新的技术给予全面的阐述及必要的说明，在可能的情况下给出相应的技术参考资料外部接口用户接口描述该软件与用户的接口，包含用户输入输出界面样式、操作方式与界面间的转移关系如具有等同作用的文件（如使用开发工具编写的界面原型程序等），本处仅需列出该文件名、保管部门即可软件接口描述该软件与其它系统的软件接口，要紧说明其它系统提供的编程接口与本系统向其它系统提供的编程接口，如具有等同作用的文件（如包含接口说明及注释的源文件程序头文件、接口帮助的超文本文件等），本处仅需列出该文件名、保管部门即可253其它接口描述该软件与其它系统的其它类型接口，要紧说明其它系统提供的与本系统向其它系统提供的硬件接口、通信协议及规程、数据交换格式等，如具有等同作用的文件，本处仅需列出该文件名、保管部门即可.模块设计功能简述各模块的功能性能说明对各模块的性能要求，包含精度、时间特性与处理速度内部接口说明各模块之间接口，包含1）各模块的用途、使用（调用）方式；2）说明其每个子程序（方法，Method）＞特性（Property）与反馈的事件（Event）相应的输入、输出项说明；3）指明各模块内含的各类外部接口，并列出这些外部接口说明材料名外部存贮结构设计说明本系统存贮于磁盘等持久性存贮介质，而且不是由数据库管理系统进行管理的数据的组织结构，包含数据名称、用途、每个数据项的标识名、类型与含义，组织结构、访问方法与存储要求.故障处理说明说明本系统所使用的基本错误处理方法与原则，比如统一使用C++try-catch错误方法所有错误最终务必以界面形式向用户说明用一览表方式说明各类可能的错误或者故障出现时系统的处理方法与补救措施.数据库设计数据字典设计对数据库设计中涉及到的各类项目，如数据项、记录、表、数据库等建立数据字典，以说明它们的标识符、同义名及有关信息，并说明对此数据字典设计的基本考虑凡使用数据库设计工具（如ER图设计工具）生成的数据字典，本处仅需列出对应的文件名、保管部门即可安全保密设计说明在数据库的设计中，如何通过区分不一致的访问者、不一致的访问类型与不一致的数据对象，进行分别对待而获得的数据库安全保密设计考虑文件编号NW506101生效日期2004-2-20受控编号密级秘密版次Ver

1.0修改状态总页数19正文4附录15编制张俊岭、郑泽梅批准序号内容YesNo不适用1整个系统组织很清晰，并包括一个良好的体系结构概述和verification2对模块进行明确定义，包括模块的功能说明和与其它模块的接口说明3包含需求分析报告中列出来的所有功能4主要的数据结构被调用函数隐藏起来了5描述数据库的组织结构和内容6描述并验证所有关键的算法7定义了用户接口的关键方面8包括一致的错误处理策略9将错误信息清晰、简洁地反映在用户界面上10体系结构的设计可以适应可能发生的变化11作为实现系统的程序员，你对这个体系结构感到满意12描述了处理用户输入的策略13清晰地阐述了系统的主要目标14所有主要的数据结构都有描述过并通过verification15描述并验证所有主要的对象16用户接口都被模块化以使其内部的变化不对程序的其它部分产生影响17对内存的使用事先作了估计并对内存管理策略进行了描述和verification18在体系结构中对每个模块的空间和速度作了预算19描述了字符串的处理策略，在其中包括了对字符-字符串存储的估计20描述并验证了对I/O处理的策略21描述了系统的健壮程度22包括必须购买的工具以及进行BUILD的决定23存在某一个部分不在体系结构描述之内24体系结构在概念上是一个整体25设计独立于机器和实现语言26所有重要决定都具有相应的动机27谁是这个特性的用户28用户如何使用这项特性？用户如何了解这项特性？方式直观明显吗？29用户使用这项特性的动机是什么？30用户对用户接口的看法如何？UI的逻辑流程是什么？用户期望的结果是什么？31如果用户在使用这项特性时没有成功地达到目标会发生什么？他（她）能做什32实现这个特性（或完成一个任务）之后，用户返回到合适的位置继续工作了吗？33特性或过程的出口明显吗？如果用户错误地激活了该项特性后能容易地退出和返34这个特性可以Undo吗？35还有其它的方法可以实现这个特性吗？如果有是什么？36用户要使用这个特性时需要了解哪些东西？是不是你不能奢望用户要掌握的？37有多少是用户必须去做但与关键任务（也可称为第一号工作）无关的任务？38两个类似过程间的对话框看起来是一致的吗？39是否同一个对话框用于多个任务？对话框的名称和选项按钮的名称随着任务而变40用户愿意把这个特性与其它特性或过程结合起来吗？41这个特性或过程与本产品或相似产品中的其它特性或过程保持一致性？42有其它的开发队伍在进行相关的特性或过程的开发？两支开发队伍的工作协调一43要对该特性或过程进行修改以适应国外市场44对丁不同语言环境，该特性需耍做相应的变化45在将来不同的版本以不同的方式来实现这个特性修改记录编号修改状态修改页码及条款修改人审核人批准人修改日期编号资料名称简介作者日期出版单位网点简介。