某軟件系統(tǒng)設計說明書

1、XX軟件系統(tǒng)設計說明書1Introduction簡介1.1Purpose目的This section should state the purpose of this document. The intended readershould also be specified here.這部分要描述文檔的目的，并指明文檔的讀者。1.2Scope范圍Name 軟件名稱Identify the software by name.對軟件命名。Functions軟件功能Explain what the software product(s) will and will not do (either di

2、rectlyor by reference to another related document).解釋軟件產(chǎn)品將完成或不完成的功能（可以直接描述也可以參考相關文檔）。Applications軟件應用Describe the application of the product (either directly or by reference toanother software document)描述軟件的應用（可直接描述也可以參考其他軟件文檔）.專業(yè) .專注 .2High Level Design概要設計2.1Level 0 Design Description第0層設計描述Softwa

3、re System Context Definition軟件系統(tǒng)上下文定義：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 (usually in drawings).首先描述本軟件系統(tǒng)在實際環(huán)境的組網(wǎng)方式（一般用圖描述）描述系統(tǒng)如何與外部實體一道組成功能實體

4、（一般用圖描述）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 and interaction.本節(jié)還要描述待開發(fā)軟件系統(tǒng)與外部實體的關系. ，可以使用系統(tǒng)架構圖、頂層數(shù)據(jù)流圖、事務圖等來描述系統(tǒng)結構和交互

5、關系。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 other software systems.The property (such as message, library invoki

6、ng) 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 the features of an external entity. Instead of a complete descripti

7、on in this specification, you can make.專業(yè) .專注 .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.所有系統(tǒng)外圍實體 ( 在設計規(guī)格流程中有定義 ) ，這些實體與軟件系統(tǒng)發(fā)生交互作用或以某種方式影響軟件系統(tǒng)，比如，操作系統(tǒng)，驅動程序，硬件，中斷，其他軟件系統(tǒng)等.外圍實體和本系統(tǒng)相互作用的性質( 比如，消息

8、，庫調用 ) 和類型 ( 比如， OS服務，通信服務，系統(tǒng)工具等 ) 。描述外部實體的特性時要注意該描述一定要有助本軟件的設計和描述。 為了本文檔內容的完整性，可以采用對于描述相關設計實體文檔索引的方式：如對于操作系統(tǒng)編程手冊的索引Design Considerations (Optional)設計思路 ( 可選 )Design Methodology設計方法Describe design methodology that shall be used in the software systemdesign. 描述本軟件系統(tǒng)所采取的設計方法。Design Alternatives設計可選方案A

9、nalysis several alternatives of system design scheme, and specify thescheme that shall be used. 對本軟件系統(tǒng)的幾種設計方案進行分析、比較，并確定所采用的方案 Design Constraints設計約束1.Standards compliance遵循標準Describe standards that software system shall comply with.描述本軟件所遵循的標準、規(guī)范2.Hardware Limitations硬件限制Describe hardware li

10、mitations of the software system.描述本軟件系統(tǒng)實現(xiàn)的硬件限制3.Technology Limitations技術限制Describe technology limitations of the software system.描述本軟件的技術限制4.Other Design Considerations其他Describe other design considerations of the software system.描述其他有關的.專業(yè) .專注 .設計考慮2.2Level 1 Design Description第一層設計描述Architecture

11、of the software system shall be described here.這里要描述軟件系統(tǒng)的總體結構。Structure chart, Hierarchical decomposition diagram, natural language canbe used to represent the architecture.總體結構描述可以使用結構圖，層次分解圖，自然語言。Decomposition Description分解描述Module/Subsystem Decomposition模塊 / 子系統(tǒng)分解This section describes subsystems

12、 ,module in the system.本節(jié)描述系統(tǒng)中的子系統(tǒng)和模塊。1.Module/Subsystem 1 Description模塊 / 子系統(tǒng) 1描述Describe as follows按照以下格式描述：Identification標識：Type 類型：Purpose目的：Functions功能列表：Sub modules: 子模塊： If this module will be further decomposed into submodules, list all sub modules here.如果本模塊還要繼續(xù)劃分，列出下屬子模塊Concurrent Process

13、Decomposition并發(fā)進程處理分解This section describes concurrent processes in the system.本節(jié)描述系統(tǒng)中的并發(fā)進程。In case of external entities, Subordinates attribute need not be described.對于外部實體，從屬屬性不必描述。1.Process 1 Description進程 1描述Describe as follows按照以下格式描述：.專業(yè) .專注 .Identification標識：Type 類型：Purpose目的：Functions功能列表：Th

14、is part describes the functions to be performed in the process. If the function has been described in module decomposition before, description should be made on what functions of the modules are implemented in this process.描述本進程中要完成的功能，如功能已經(jīng)在前面的模塊分解中有描述，則重點描述本進程完成了哪些模塊的哪些功能。Data Decomposition數(shù)據(jù)分解Thi

15、s section describes data stores in the system.本節(jié)描述系統(tǒng)中的數(shù)據(jù)結構。External data entities shall not be described.外部數(shù)據(jù)實體不必描述。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. When des

16、cribing the data, make sure the data is the global data of the level.本章節(jié)描述本系統(tǒng)中用到的全局數(shù)據(jù)結構，其中至少包括：各分解模塊直接訪問的數(shù)據(jù)，被各分解模塊用來在接口中使用的結構。描述數(shù)據(jù)時要注意該數(shù)據(jù)是否真正為本級模塊分解的公用數(shù)據(jù)。1.Data Entity 1 Description數(shù)據(jù)實體 1描述Describe as follows按照以下格式描述：Identification標識：Type 類型：Purpose目的：Dependency Description依賴性描述This section describe

17、s relationships among the design entities such as.專業(yè) .專注 .subsystems, data stores, modules, and processes etc.本節(jié)描述系統(tǒng)中的子系統(tǒng)，數(shù)據(jù)結構，模塊，進程等設計實體間的關系。Structure charts, transaction diagrams, MSC, ER diagram can be used torepresent dependences.依賴關系描述可以使用結構圖（交互）事務圖，消息序列圖, ER圖。Running Design運行設計This section des

18、cribes how the modules and the processes of this design level cooperate to perform the functional requirements of the system. MSC, transaction diagrams, Structure charts can be used to represent the running procedure. Note: All the functional requirements in SRS should be covered in the description.

19、 For Level 2, Function specification of the module to be decomposed should be covered.本章節(jié)描述本層設計的各個模塊和進程是如何配合完成系統(tǒng)的功能需求.可以用消息序列圖 , ( 交互 ) 事務圖 ,結構圖等進行描述 ,可以按照處理過程進行分節(jié)描述 ,要注意的是描述的內容應該涵蓋所有 SRS文檔的功能需求 , 對于二級設計來講 ,就是要涵蓋分解對象模塊的功能規(guī)格Data Dependencies數(shù)據(jù)依賴關系This section describes relationships among data stores

20、。本節(jié)描述數(shù)據(jù)結構間的關系。ER diagram can be used to represent dependences.依賴關系描述可以使用 ER圖。Interface Description接口描述This section describesinterfaces of the design entities (such assubsystem, module, process)that make up the system。本節(jié)描述軟件系統(tǒng)中設計實體 ( 如子系統(tǒng)，模塊，進程）的接口 .Interface files, parameter tables can be used to de

21、scribe Interface.接口描述可以使用接口文件，參數(shù)表。.專業(yè) .專注 .In case of external entities, only the interfaces relevant to the softwarebeing described need be described.對于外部實體只有同被描述軟件相關的接口才需描述。Module/Subsystem Interfaces模塊 / 子系統(tǒng)接口This section describes interfaces of Module/Subsystem Interfaces。本節(jié)描述模塊 / 子系統(tǒng)的接口。1.Inter

22、faces Provided by Module/Subsystem 1模塊 / 子系統(tǒng) 1提供的接口For 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.對于接口函數(shù)，可以采用以下形式描述：接口 1：形式：輸入：輸出：返回：描述返回什么。描述：總體描述該接口實現(xiàn)的目的

23、。Process Interfaces進程接口This section describes interfaces of process。本節(jié)描述進程的接口。1.Process 1 Description進程 1描述The interfaces between the processes describe the shared memory, protocol data and messages, etc.進程間的接口主要是描述一些共享內存，協(xié)議數(shù)據(jù)，消息等。Describe as follows按照以下格式描述：.專業(yè) .專注 .Identification標識：Type 類型：Purpose

24、目的：Functions功能列表：2.3Level 2 Design Description（ Optional ）第二層設計描述（可選）Each entity that is defined in L1 and identified for further descriptionshall be described by separate sub-sections as mentioned below.L1中定義的每個實體的進一步設計在下面的章節(jié)進行描述。This will be repeated for each module as follows (Same as Level 1). T

25、he detailed suggestions are also the same as Level 1.對每個模塊重復使用下述的格式( 和一層設計一樣 ) 。具體的編寫建議參見第一層設計Module name (1)模塊 1名稱Decomposition Description分解描述1.Module/Subsystem Decomposition模塊 / 子系統(tǒng)分解1 ）Module/Subsystem 1 Description模塊 / 子系統(tǒng) 1描述2 ）Module/Subsystem 2 Description模塊 / 子系統(tǒng) 2描述*2.Concurrent Pro

26、cess Decomposition并發(fā)進程處理分解1 ）Process 1 Description進程 1描述2 ）Process 2 Description進程 2描述*3.Data Decomposition 數(shù)據(jù)分解1 ）Data Entity 1 Description數(shù)據(jù)實體 1描述2 ）Data Entity 2 Description數(shù)據(jù)實體 2描述*.專業(yè) .專注 .Dependency Description依賴性描述1. Running Design 運行設計2. Data Dependencies 數(shù)據(jù)依賴關系3. *Interface Descripti

27、on接口描述1.Module/Subsystem Interfaces模塊 / 子系統(tǒng)接口1 ）Interfaces Provided by Module/Subsystem 1模塊 / 子系統(tǒng) 1提供的接口2 ）Interfaces Provided by Module/Subsystem 2模塊 / 子系統(tǒng) 2提供的接口*2.Process Interfaces進程接口1 ）Process 1 Description進程 1描述2 ）Process 1 Description進程 1描述*Module name (2)模塊 2名稱*2.4Configurationand Control（

28、Optional）配置 和控 制（可選）Startup啟動Describes the steps to start up a module描述啟動一個模塊的步驟Closing關閉Describes the steps to close a module描述關閉一個模塊的步驟Creating MIB Table Item MIB表項的創(chuàng)建.專業(yè) .專注 .Steps to create a new table item. The title of this section can be modified.創(chuàng)建新表項的動作步驟。該節(jié)的標題可以適當更改Deleting MIB Table Item

29、MIB表項的刪除Steps to delete a table item. The title of this section can be modified.刪除表項的動作步驟 .該節(jié)的標題可以適當更改Modifying MIB Table Item MIB表項的更改Steps to modify a table item. The title of this section can be modified.修改表項的動作步驟 .該節(jié)的標題可以適當更改。2.5Database （Optional ）數(shù)據(jù)庫（可選）Entity, Attributes and their relationshi

30、ps實體、屬性及它們之間的關系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, specific constraints and a verbose description of that attribute should be speci

31、fied. All specific constraints for that entity and its relationship with other entities should also be noted.本節(jié)列出所有的數(shù)據(jù)存儲類的實體，詳細描述實體的內容和并列出全部屬性。對每個屬性，詳細描述其數(shù)據(jù)庫、數(shù)據(jù)大小、特定約束。實體的所有約束及實體間的關系也要注明。E-R diagram實體關系圖This section should display the E-R diagram for all the entities listedabove.本節(jié)描述關于上節(jié)提到的所有實體的E-R圖

32、.專業(yè) .專注 .3Detailed Design詳細設計This section should focus on the description of the detailed design of the software entities that are a part of the software being described by the HLDSpecification。.對于在概要設計說明書中給出的軟件實體，本節(jié)集中描述它們的詳細描述部分。3.1 Module 1 Detail Design模塊 1詳細設計Describe data that defined or used i

33、n the module, including:Simple datai.e. global variable, constant or macro within the module;Complex datai.e. Structure or union.描述模塊中定義和使用的數(shù)據(jù)，包括：簡單數(shù)據(jù)，如模塊級的全局變量、常量、宏；復合數(shù)據(jù)，如模塊內部的結構、聯(lián)合.；Data Description數(shù)據(jù)描述Describe simple variables, constant or macro of the module in sub-section 1; Describe complex da

34、ta from sub-section 2, such as structure, union;在1中描述本模塊中的簡單變量、常量、宏；從第 2部分起描述本模塊中的復合數(shù)據(jù)，如結構、聯(lián)合等；Simple Data Description簡單數(shù)據(jù)描述；describe simple variables、constant or macro used or defined in this module;描述在本模塊中定義和使用的簡單變量、常量、宏；Describes simple variables, constants used or defined in this module;The desc

35、ription of simple data should follow the format below:Function Description: Describing the usage of the dataData Definition: Defining the data按照下列格式進行簡單數(shù)據(jù)的描述.專業(yè) .專注 .功能描述：描述該數(shù)據(jù)的用途數(shù)據(jù)定義：定義該數(shù)據(jù)Structure 1結構 1Define and describe the Data structure (include union)定義和說明該數(shù)據(jù)結構 ( 包括聯(lián)合 );The description of dat

36、a structure should follow the format below:Data Structure Description: Describing the usage of the data structureData Structure Definition: Defining the data structure with the actualprogramming languageData Items Description:Data TypeData Item DefinitionData Item Description按照下列格式進行數(shù)據(jù)結構的描述數(shù)據(jù)結構描述：描述

37、該數(shù)據(jù)結構的用途數(shù)據(jù)結構定義：用實際的編程語言定義該數(shù)據(jù)結構數(shù)據(jù)項描述：數(shù)據(jù)類型數(shù)據(jù)項定義數(shù)據(jù)項描述Structure 2結構 2Function Description函數(shù)描述This section should follow the format below:Identification: Title of the moduleType: Type of the module, for example, the module in Level 2 Design, the process in Level 1 Design, etc.專業(yè) .專注 .Function Description

38、: Describing the functions of the module in brief, which should be consistent with the related section of the HLD documents.Function Invoking Relation: Using the Hierarchy Chart or Structure Chart to describe it, for example:本節(jié)應按照下列格式進行描述：標識：模塊名稱類型：模塊類型，如， 2級設計中的模塊， 1級設計中的進程功能概述：簡要描述本模塊功能，要和概要設計文檔中相

39、關模塊分解的描述一致。函數(shù)調用關系 : 用層次圖或結構圖的方式描述函數(shù)調用關系，如：Function1A,BD,ECFunction2Function3圖 1 Module 1 Structure Chart模塊 1結構圖Function 1函數(shù) 1Descript the function as follows;Function:/ name of functionDescription:/ functionality of the functionCalls:/ function lists which called by this functionData Accessed: / global variables or database tables to be visitedData Updated: / global variables or database tables to be modifiedInput:/ description of each input parameter,/ including function desc