华为软件概要设计模板

《华为软件概要设计模板》由会员分享，可在线阅读，更多相关《华为软件概要设计模板（15页珍藏版）》请在装配图网上搜索。

1、产品名称 Product name密级 Confidentiality level产品版本 Product versionTotal 15pages共 15 页XX High Level Design Specification XX 概要设计说明书Prepared byName+IDDateyyyy-mm-dd拟制姓名 +工号日期Reviewed byDateyyyy-mm-dd评审人日期Approved byDateyyyy-mm-dd批准日期XXXX Co., Ltd. XXXX 有限公司DateRevisio日期nVersion修订版本Revision Record修订记录CR IDS

2、ecChange DescriptionAuthor/No.修改描述作者Defec修改t ID章节CR 号Catalog目 录1Introduction简介61.1Purpose目的61.2Scope范围6Name 软件名称6Functions软件功能6Applications 软件应用62High Level Design概要设计62.1Level 0 Design Description第零层设计描述6Software System Context Definition软件系统上下文定义6Design Considerations (Optional)设计思路 (可选 )72.2Level

3、 1 Design Description第一层设计描述8Decomposition Description分解描述8Dependency Description依赖性描述9Interface Description接口描述102.3Level 2 Design Description（ Optional ）第二层设计描述（可选）12Module name (1)模块 1名称12Module name (2)模块 2名称132.4Configuration and Control（ Optional ）配置和控制（可选）14Startup 启动14Closing 关闭14Creating MI

4、B Table Item MIB表项的创建14Deleting MIB Table Item MIB表项的删除14Modifying MIB Table Item MIB表项的更改142.5Database（ Optional ）数据库（可选）14Entity, Attributes and their relationships实体、属性及它们之间的关系14E-R diagram实体关系图14Table List表目录Table1* 表1 *表表 .错误！未定义书签。错误！未定义书签。Figure List图目录Figure 1* 图 .图 1* 图 .错误！未定义书签。错误！未定义书签。X

5、X High Level Design Specification XX 概要设计说明书Keywords关键词：Abstract摘要：Listofabbreviations缩略语清单：Abbreviations缩略语Full spelling英文全名Chinese explanation中文解释1Introduction 简介1.1Purpose 目的This section should state the purpose of the document. It could also specify the intended audience.这部分要描述文档的目的。应该指明读者。1.2Sc

6、ope 范围Name 软件名称Identify the software by name对软件命名软件功能Explain what the software product(s) will and will not do (either directly or by reference to another software document).解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）软件应用Describe the application of the product (either directly or by reference to another softw

7、are document)描述软件的应用（可直接描述也可以参考其它软件文档）2High Level Design 概要设计2.1Level 0 Design Description 第零层设计描述软件系统上下文定义Describes the network organizing mode of the software system in actual environment (usually in drawings).Describes how the software system forms a functional entity with other external entities

8、 (usually in drawings).首先描述本软件系统在实际环境的组网方式（一般用图描述）描述系统如何与外部实体一道组成功能实体（一般用图描述）This section describes relationships between the software system to be developed and external entities. Architecture Diagram, Top level DFD (Data-Flow-Diagram) or transaction diagrams can be used to describe architecture an

9、d interaction.本节还要描述待开发软件系统与外部实体的关系.，可以使用系统架构图、顶层数据流图、事务图等来描述系统结构和交互关系。All external entities of the software system (defined in Procedure of Design Specification) that interact with the software system, or affect the software system in a certain mode, for example, OS, driver, hardware, interrupt or

10、other software systems.The property (such as message, library invoking) and type (such as OS service, communication service, system tools, etc.) of the interaction between external entities and this system. Only the contents that are helpful in the software design should be included while describing

11、 the features of an external entity. Instead of a complete description in this specification, you can make indexes to refer to the relative documents that describe the software design. For example, an index can be made for the programming guidance of the OS.所有系统外围实体 (在设计规格流程中有定义 )，这些实体与软件系统发生交互作用或以某

12、种方式影响软件系统，比如，操作系统，驱动程序，硬件，中断，其它软件系统等.外围实体和本系统相互作用的性质(比如，消息，库调用 )和类型 (比如， OS 服务，通信服务，系统工具等 )。描述外部实体的特性时要注意该描述一定要有助本软件的设计和描述。为了本文档内容的完整性，可以采用对于描述相关设计实体文档索引的方式：如对于操作系统编程手册的索引Design Considerations (Optional) 设计思路 ( 可选 )设计方法Describe design methodology that shall be used in the software system design.描述本软

13、件系统所采取的设计方法。设计可选方案Analysis several alternatives of system design scheme, and specify the scheme that shallbe used.对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案Design Constraints设计约束1Standards compliance 遵循标准Describe standards that software system shall comply with.描述本软件所遵循的标准、规范2Hardware Limitations硬件限制Describe ha

14、rdware limitations of the software system.描述本软件系统实现的硬件限制3Technology Limitations技术限制Describe technology limitations of the software system.描述本软件的技术限制其它Describe other design considerations of the software system.描述其它有关的设计考虑2.2Level 1 Design Description 第一层设计描述Architecture of the software system shall

15、be described here.这里要描述软件系统的总体结构。Structure chart, Hierarchical decomposition diagram, natural language can be used to represent the architecture. 总体结构描述可以使用结构图，层次分解图，自然语言。分解描述模块 /子系统分解This section describes subsystems ,module in the system.本节描述系统中的子系统和模块。1Module/Subsystem 1 Description 模块 /子系统 1 描述D

16、escribe as follows按照以下格式描述：Identification标识：Type 类型：Purpose 目的：Functions功能列表：Requirement IDs to implement要实现的需求 ID:Submodules:子模块： If this module will be further decomposed into submodules, list allsubmodules here.如果本模块还要继续划分，列出下属子模块2Module/Subsystem 2 Description 模块 /子系统 2 描述Concurrent Process Deco

17、mposition 并发进程处理分解This section describes concurrent processes in the system.本节描述系统中的并发进程。In case of external entities, Subordinates attribute need not be described.对于外部实体，从属属性不必描述。1Process 1 Description 进程 1 描述Describe as follows 按照以下格式描述：Identification 标识：Type类型：, ER图。Purpose 目的：Functions功能列表：This

18、part describes the functions to be performed in the process. If the function has beendescribed in module decomposition before, description should be made on what functions of the modules are implemented in this process.描述本进程中要完成的功能，如功能已经在前面的模块分解中有描述，则重点描述本进程完成了哪些模块的哪些功能。2Process 2 Description 进程 2 描

19、述数据分解This section describes data stores in the system.本节描述系统中的数据结构。External data entities shall not be described.外部数据实体不必描述。Describes the global data structure of the system, including: the data directly accessed by decomposed modules, and the data structure used in interface of decomposed modules.

20、When describing the data, make sure the data is the global data of the level.本章节描述本系统中用到的全局数据结构，其中至少包括：各分解模块直接访问的数据，被各分解模块用来在接口中使用的结构。描述数据时要注意该数据是否真正为本级模块分解的公用数据。1Data Entity 1 Description 数据实体 1 描述Describe as follows按照以下格式描述：Identification标识：Type 类型：Purpose 目的：2Data Entity 2 Description 数据实体 2 描述依赖

21、性描述This section describes relationships among the design entities such as subsystems, datastores, modules, and processes etc.本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。Structure charts, transaction diagrams, MSC, ER diagram can be used to representdependences.依赖关系描述可以使用结构图（交互）事务图，消息序列图运行设计This section describe

22、s how the modules and the processes of this design level cooperate to perform the functional requirements of the system. MSC, transaction diagrams, Structure chartscan be used to represent the running procedure. Note: All the functional requirements in SRS should be covered in the description. For L

23、evel 2, Function specification of the module to be decomposed should be covered.本章节描述本层设计的各个模块和进程是如何配合完成系统的功能需求. 可以用消息序列图 ,(交互)事务图 , 结构图等进行描述 , 可以按照处理过程进行分节描述, 要注意的是描述的内容应该涵盖所有 SRS 文档的功能需求 , 对于二级设计来讲 , 就是要涵盖分解对象模块的功能规格数据依赖关系This section describes relationships among data stores。本节描述数据结构间的关系。ER diagr

24、am can be used to represent dependences.依赖关系描述可以使用 ER 图。接口描述This section describesinterfaces of the design entities (such as subsystem, module,process)that make up the system。本节描述软件系统中设计实体(如子系统，模块，进程）的接口.Interface files, parameter tables can be used to describe Interface.接口描述可以使用接口文件，参数表。In case of

25、external entities, only the interfaces relevant to the software being described need be described.对于外部实体只有同被描述软件相关的接口才需描述。Module/Subsystem Interfaces 模块 /子系统接口This section describes interfaces of Module/Subsystem Interfaces。本节描述模块 /子系统的接口。1Interfaces Provided by Module/Subsystem 1 模块 /子系统 1 提供的接口For

26、 interface function, following format should be used:Interface 1:Format:Input:Output:Return: Describes the return value of the functionDescription: Describes the objective of the interface.对于接口函数，可以采用以下形式描述：接口1：形式：输入：输出：返回：描述返回什么。描述：总体描述该接口实现的目的。2Interfaces Provided by Module/Subsystem 2 模块 /子系统 2 提

27、供的接口进程接口This section describes interfaces of process。本节描述进程的接口。1Process 1 Description 进程 1 描述The interfaces between the processes describe the shared memory, protocol data and messages, etc.进程间的接口主要是描述一些共享内存，协议数据，消息等。Describe as follows按照以下格式描述：Identification标识：Type 类型：Purpose 目的：Functions功能列表：2Proc

28、ess 2 Description 进程 2 描述2.3Level 2 Design Description （Optional ）第二层设计描述（可选）Each entity that is defined in L1 and identified for further description shall be described byseparate sub-sections as mentioned below.L1中定义的每个实体的进一步设计在下面的章节进行描述。This will be repeated for each module as follows (Same as Lev

29、el 1). The detailed suggestions are also the same as Level 1.对每个模块重复使用下述的格式(和一层设计一样 )。具体的编写建议参见第一层设计模块 1 名称分解描述1Module/Subsystem Decomposition 模块 /子系统分解1） Module/Subsystem 1 Description 模块 /子系统 1 描述2） Module/Subsystem 2 Description 模块 /子系统 2 描述*2Concurrent Process Decomposition 并发进程处理分解1） Process 1

30、Description 进程 1 描述2） Process 2 Description 进程 2 描述*数据实体描述Describe as follows按照以下格式描述模块内部使用的多个数据实体：Identification标识：Type & structure(if applicable)类型及组成结构（必要的话）：Purpose目的：依赖性描述1 Running Design 运行设计2 Data Dependencies数据依赖关系*接口描述1Module/Subsystem Interfaces 模块 /子系统接口1） Interfaces Provided by Module/Su

31、bsystem 1 模块 /子系统 1 提供的接口2） Interfaces Provided by Module/Subsystem 2 模块 /子系统 2 提供的接口*2Process Interfaces进程接口1） Process 1 Description 进程 1 描述2） Process 1 Description 进程 1 描述*模块 2 名称*2.4Configuration and Control （ Optional ）配置和控制（可选）Startup 启动Describes the steps to start up a module.描述启动一个模块的步骤关闭Desc

32、ribes the steps to close a module.描述关闭一个模块的步骤表项的创建Steps to create a new table item. The title of this section can be modified.创建新表项的动作步骤。该节的标题可以适当更改表项的删除Steps to delete a table item. The title of this section can be modified.删除表项的动作步骤 . 该节的标题可以适当更改表项的更改Steps to modify a table item. The title of this

33、 section can be modified.修改表项的动作步骤 . 该节的标题可以适当更改。2.5Database （ Optional ）数据库（可选）实体、属性及它们之间的关系This section could list all the entities such as data stores, a verbose description of what that entity pertains to and list of all its attributes. For each of the attributes, its database, the data size, sp

34、ecific constraints and a verbose description of that attribute should be specified. All specific constraints for that entity and its relationship with other entities should also be noted.本节列出所有的数据存储类的实体，详细描述实体的内容和并列出全部属性。对每个属性，详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。实体关系 图This section should display t

35、he E-R diagram for all the entities listed above.本节描述关于上节提到的所有实体的E-R 图List of reference参考资料清单：Please list referred literature and related documents, format:请罗列本文档所参考的有关参考文献和相关文档，格式如下：Author + book name (or magazine, literature, document) + publishing company (or issue No.,volume No., internal docume

36、ntation ID) + publishing date + start and end page number,作者书名（或杂志、文献、文档）出版社（或期号、卷号、公司文档编号）出版日期+起止页码Examples:例如：1D. B. Leeson,“ A Simple Model of Feedback Oscillator Noise Spectrum,” Proc. IEEE,- pp329330, February 1966（英文文章格式）2D. Wolaver, Phase-Locked Loop Circuit Design, Prentice Hall, New Jersey,1991（英文书籍格式）3王阳元，奚雪梅等，薄膜SPICE电路模拟，电子学报，vol.22，No.5，1994“SOI/CMOS”（中文文章格式）4 郑筠， MOS 存储系统及技术，科学出版社， 1990 （中文书籍格式）5 XXX ，SDXXX 用户手册 V1.1 ，基础部文档室， 2001/4/26