公司系统设计报告编写规范样本.doc

系统设计汇报编写规范文件编号： NW506101 生效日期： .3.20受控编号：密级：秘密版次：Ver2.1修改状态：总页数19正文4附录15编制：胡景德审核：袁淮、孟莉同意：孟莉沈阳东大阿尔派软件股份（版权全部，翻版必究）文件修改控制修改统计编号修改状态修改页码及条款修改人审核人同意人修改日期目录1. 目标2. 适用范围3. 术语及缩略语4. 编写规范4.1 排版规范4.2 模板使用5. 引用文件6. 附录1. 目标系统设计汇报关键为使软件产品和软件项目满足要求软件规格要求而确定软件系统体系结构、组成成份、数据组织、模块、内外部接口。关键任务有：1) 建立软件产品和软件项目目标系统总体结构。对于大规模软件系统，应分为若干子系统，在本汇报中只说明总体设计，然后为每个子系统编写系统设计汇报；2) 总体设计；3) 模块设计；4) 包含使用数据库设计需编写数据库设计。2. 适用范围适适用于软件开发设计阶段系统设计汇报编写。3. 术语及缩略语本程序采取NQ402100质量手册中术语和缩略语及其定义。4. 编写规范4.1 排版规范1） 整个规范由2节组成，模板单独一节。2） 正文样式采取“规范正文”。3） 标题编号采取每节独立编号。4.2 模板使用系统设计汇报编写可依据具体情况选择摸板格式或编写指南格式。1） 拷贝规范。2） 删除第一节（系统设计汇报封面前全部页）。3） 在修改完内容后，更新目录域和相关页数域。5. 引用文件(无)6. 附录以下部分为系统设计汇报模板和编写指南。密级：机密文档编号：第 版分册名称：第 册/共 册项目名称（项目编号）系统设计汇报（部门名称）沈阳东大阿尔派软件股份总页数正文附录生效日期： 年 月 日编制：审核：同意：目录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 安全保密设计1.引言1.1目标说明编写本系统设计说明书目标。1.2背景：说明了解本汇报所需背景，如和企业其它软件之间联络等。1.3术语列出本系统设计说明书中专门术语定义和英文缩写词原词组。1.4参考资料：列出编写参考文件、资料、技术标准和她们作者、标题、编号、公布日期和出版单位。编号资料名称介绍作者日期出版单位列出编写本汇报时需查阅Intenet上杂志、专业著作、技术标准和她们网址。网点介绍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 内部接口说明各模块之间接口，包含：1) 各模块用途、使用(调用)方法；2) 说明其每个子程序（方法，Method）、特征（Property）和反馈事件（Event），对应输入、输出项说明；3) 指明各模块内含各类外部接口，并列出这些外部接口说明材料名。3.4 外部存贮结构设计说明本系统存贮于磁盘等持久性存贮介质，而且不是由数据库管理系统进行管理数据组织结构，包含数据名称、用途、每个数据项标识名、类型和含义，组织结构、访问方法和存放要求。4. 故障处理说明说明本系统所采取基础错误处理方法和标准，比如：统一采取C+ try-catch错误方法，全部错误最终必需以界面形式向用户说明。用一览表方法说明各类可能错误或故障出现时系统处理方法和补救方法。5. 数据库设计5.1 数据字典设计对数据库设计中包含到多种项目，如数据项、统计、表、数据库等建立数据字典，以说明它们标识符、同义名及相关信息，并说明对此数据字典设计基础考虑。凡采取数据库设计工具（如ER图设计工具）生成数据字典，本处仅需列出对应文件名、保管部门即可。5.2 安全保密设计说明在数据库设计中，怎样经过区分不一样访问者、不一样访问类型和不一样数据对象，进行分别对待而取得数据库安全保密设计考虑。系统设计汇报编写指南之一 1.Introduction介绍l 描述这个文档编写目标；l 描述这个文档适用范围；l 描述这个文档读者；l 确定这个系统/产品名称和/或版本号；l 定义关键术语、缩写词或缩略语；l 总结（或给出一个概要）这个文档内容。2.System Overview系统概述对软件系统通常性描述，包含系统功效和其它和设计相关内容。3.Design Considerations设计上考虑本节描述在完成一个完整设计处理方案之前必需说明或处理问题。3.1Assumptions and Dependencies假设和依靠l 相关软件和硬件l 操作系统l 最终用户特征l 在功效上可能发生改变3.2 General Constraints通常限制l 描述对软件系统设计相关键影响全局限制或约束。l 硬件或软件环境；l 最终用户环境；l 资源可用性和挥发性；l 标准兼容；(option)l 协同工作要求；l 接口/协议要求；l 数据储存和公布要求；l 安全性要求（或其它类似规则）；l 内存和其它容量限制；l 性能要求；l 网络通信；(option)l 验证和确定要求（测试）；l 其它质量目标要求；l 在需求分析说明书中所描述其它要求。3.3 Goals and Guidelines目标和指导方针描述全部支配软件系统设计目标、指导方针、标准或优先权。l 尽可能保持它简单易用；l 强调速度和内存使用矛盾；l 象对待一个已经存在产品那样工作、观察或体会。3.4 Development Methods开发方法简明地描述用于软件设计方法。假如采取正式/已公布方法，那么就要对这些方法进行具体描述，同时还要简单解释一下为何采取这个方法或其中一些部分。4.Architectural Strategies体系结构策略描述全部影响整个系统组织和结构设计决定和/或策略，这些策略深入描述系统体系结构所使用关键技术和机制。对于每个设计决定和/或策略全部要描述其产生原因（可能要引用前面叙述设计目标和标准），和它们是怎样得到均衡和折中，包含内容：l 使用特定类型产品（编程语言、数据库、函数库等）；l 重用现有组件；l 软件未来扩展和升级计划；l 用户接口模型（或系统输入和输出模型）；l 硬件或软件接口模型；l 错误检测和恢复；l 内存管理策略；l 外部数据库和/或数据存放管理和维护；l 网络上分布式数据或控制；l 控制通常方法；l 并发和同时；l 通信机制；l 其它资源管理。每一个被采取关键战略必需在对应子章节内加以讨论。5.System Architecture系统体系结构在本节应该在一个较高层次来说明怎样将系统功效划分给各个子系统或组件，不要包含这些组件本身细节（后面有一个小节专门来具体描述组件）。本节关键目标是描述系统是怎样进行分解、这么分解原因和各部分是怎样协作工作以完成预定功效。在较高层次上描述系统所要负担关键工作责任、系统所饰演多种角色；描述怎样将系统划分成各个组件/子系统，每个组件/子系统作用是什么；描述高层组件之间是怎样协调工作已完成预期功效；进行系统分解时所采取基础标准；能够使用图表、模型、步骤图等形式来描述上述内容。5.1 Subsystem Architecture子系统体系结构建立一个子章节来具体描述某一组件作用，深入描述该组件是怎样分为子组件和各个子组件之间关系。6.Policies and Tactics政策和实施策略描述影响系统接口细节和系统实现细节各个方面：l 选择特定产品来使用（如编译器、解释器、数据库、函数库等）；l 工程上折中；l 编码规范和通例；l 一个或多个子系统、模块或子程序协议；l 选择某一特定算法或编程用语来实现系统一部分；l 功效性说明；l 确保需求可回溯性计划；l 软件测试计划；l 软件维护计划；l 最终用户、软件、硬件和通信接口；l 将源代码根据物理形态（文件和路径）进行分层组织；l 怎样结构和/或产生系统交付物（怎样编译、链接、加载等）。以上各项内容必需有对应子章节进行讨论。假如还有其它方案可供选择时，要说明你没有选择这些方案原因。能够使用图表、模型、步骤图等形式来描述上述内容。7.Detailed System Design具体设计在系统体系结构中所描述绝大多数组件需要在本章节进行更深一步讨论，一样，其它低层组件和子组件也需要描述。为每个组件建立一个子章节来具体描述组件，包含以下内容：l Classification 分类 组件种类，比如是一个子系统、模块、类、包、函数、文件等等。l Definition 定义组件确实切用途和语义。可能需要参考需求说明。l Responsibilities 责任该组件关键责任和/或行为，要完成什么？饰演什么角色？给用户提供哪写服务？可能需要参考需求说明。l Constraints 约束和该组件相关任何假设、限制、或约束，如时间、存放或组件状态，还可能包含和该组件进行交互规则（前提条件，后置条件，不变量，其它在输入和输出值、局部或全局值上限制，数据格式和数据存取，同时，例外等）。l Composition 合成 描述组成该组件子组件及其用途。l Uses/Interactions 用户/接口描述该组件和其它组件之间关系，如该组件被哪些组件所使用？该组件使用了哪些其它组件？这关系到所使用交互作用方法。面向对象设计必需描述那些已知和预期子类、超类和元类。l Resources 资源描述这个组件所管理、影响和使用全部资源，如内存、处理器、打印机、数据库或软件库，要描述可能存在资源竞争、死锁等情况和对应处理方案。l Processing 过程描述该组件实施过程，包含所使用算法、状态改变、相关时间或空间复杂性、并发、创建方法、初始化、清除和例外情况处理。l Interface/Exports 界面/出口描述该组件所提供服务，如资源、数据、类型、常量、子程序和例外等集合，明确定义每一个服务元素，即分类、定义、责任、约束、组合、使用、资源、处理和接口描述。7.1 Detailed Subsystem Design具体子系统设计在本章节内对该组件进行更具体描述，可使用部分复杂图表来显示组件结构、行为、或信息/控制流。8.Glossary词汇表列出在文档中所定义术语和概念。9.Bibliography参考书目一个参考书目和/或相关出版物列表。系统设计汇报编写指南之二.Objectives 目标描述系统设计汇报内容和目标。.Scope 范围适适用于指导包含设计阶段项目编写系统设计汇报。3. References 参考4. Outstanding Issues 尚存关键问题5. Approvals 同意R&D单位责任人6. Responsibilities职责6.1开发部长对系统设计汇报进行审核；6.2项目管理部门组织对系统设计汇报进行评审；6.3设计人员提交符合本指南系统设计汇报。6.4设计人员对设计阶段文档进行配置管理。7. Template 模板7.1Introduction 绪论l 项目概述；l 所设计产品概述。7.2System Description 系统描述7.2.1Support for Requirements 对需求支持l 设计满足需求程度；l 设计未能完全满足需求及其原因。7.2.2 System Purpose 系统目标简述所开发系统，假如本系统同其它系统有不管是手工还是计算机方面关系，也要描述。可参考需求分析汇报内容。7.2.3Inputs and Outputs 输入和输出具体描述系统全部输入和输出，包含界面设计、报表设计，参数格式。7.2.4Functions功效描述系统所提供全部功效。7.2.5Stored data 数据存贮简述系统数据文件。7.2.6Security and backup 安全和备份系统在安全和备份方面考虑和设计，包含回滚和恢复。7.2.7Exception handling 例外处理系统产生全部错误信息列表，包含错误发生条件和所采取方法。全部例外情况列表，和系统所采取方法。7.2.8Impact assessment 影响评定描述系统对现有环境关键影响，如工序改变，工作量改变和硬件改变。能够参考需求分析汇报内容。7.3User Procedures 用户规程7.3.1System navigation 系统导航描述那些使用户能充足使用系统规则；7.3.2Routine 例程l 描述在正常工作环境下，系统预期使用方法；l 使用步骤图来描述例程，步骤图要带有辅助描述，描述那些使用每个功效用户类型。7.3.3Exception 例外处理描述系统在异常情况下所使用处理方法，如网络失效时数据恢复。7.3.4Installation 安装描述系统安装过程。7.4System architecture 系统结构7.4.1Design principles 设计标准描述系统设计所采取策略，如用户界面形式，所使用标准产品等。7.4.2Design rationale 设计原理l 描述进行设计依据，如数据库结构等；l 模块调用原理：是内部还是外部，是修改还是重建或重用。7.4.3Software components and interfaces 软件组件和接口l 描述系统中关键组件，包含它们之间传输包和数据流；l 数据流图和功效分解图；l 描述所引用外部模块。7.4.4Capacity requirements系统资源需求估量系统容量等需求临界值，如内存、磁盘空间和、传输速率等。7.4.5System structure 系统结构描述系统各模块是怎样连接在一起工作。7.5Data 数据7.5.1Definitions 定义对系统中包含全部数据项描述。7.5.2Database design 数据库设计l 对逻辑数据库/文件设计描述；l 对物理数据库/文件设计描述；l 数据校验规则。7.5.3Calculations 算法l 定义系统所采取计算或算法；l 确定实现这些算法步骤。7.5.4Data management procedures 数据管理程序描述对系统数据管理步骤，如存档等。7.6Module specifications 模块说明l 具体描述每个模块逻辑、功效或每个模块全部状态、和其它模块关联、状态变迁、存在条件及采取动作；l 使用简练、标准语言；l 说明每个模块输入和输出。7.7Physical environment 物理环境描述建立和运行系统所需要物理环境。7.8Appendices 附录l 数据流图l 数据模型