某軟件系統(tǒng)設(shè)計(jì)說明書

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

2、er directly or by reference to another related document).解釋軟件產(chǎn)品將完成或不完成的功能(可以直接描述也可以參考相關(guān)文檔)。Applications軟件應(yīng)用Describe the application of the product (either directly or by reference to another software document)描述軟件的應(yīng)用(可直接描述也可以參考其他軟件文檔)2 High Level Design 概要設(shè)計(jì)Level 0 Design Description 第0層設(shè)計(jì)描述Software

3、 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)在實(shí)際環(huán)境的組網(wǎng)方式(一般用圖描述)描述系統(tǒng)如何與外部實(shí)體一道組成功能實(shí)體(

4、一般用圖描述)This section describes relationships between the software system to be developed and external entities. Architecture diagram, Top level DFD (DataFlow-Diagram) or transaction diagrams can be used to describe architecture and interaction.本節(jié)還要描述待開發(fā)軟件系統(tǒng)與外部實(shí)體的關(guān).系可以使用系統(tǒng)架構(gòu)圖、頂層數(shù)據(jù)流 圖、事務(wù)圖等來描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系。

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 invoking)

6、 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 description

7、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.所有系統(tǒng)外圍實(shí)體（在設(shè)計(jì)規(guī)格流程中有定義，這些實(shí)體與軟件系統(tǒng)發(fā)生交互作用或 以某種方式影響軟件系統(tǒng)，比如，操作系統(tǒng)，驅(qū)動(dòng)程序，硬件，中斷，其他軟件系.統(tǒng)等外圍實(shí)體和本系統(tǒng)相互作用的性質(zhì)比如，消息，庫(kù)調(diào)用和類型（比如，OS服務(wù)，通

8、信 服務(wù)，系統(tǒng)工具等。描述外部實(shí)體的特性時(shí)要注意該描述一定要有助本軟件的設(shè)計(jì)和描 述。為了本文檔內(nèi)容的完整性，可以采用對(duì)于描述相關(guān)設(shè)計(jì)實(shí)體文檔索引的方式：如對(duì)于 操作系統(tǒng)編程手冊(cè)的索引Design Considerations （Optional）設(shè)計(jì)思路（可選）Design Methodology 設(shè)計(jì)方法Describe design methodology that shall be used in the software system design .描述本軟件系統(tǒng)所采取的設(shè)計(jì)方法。Design Alternatives 設(shè)計(jì)可選方案Analysis several alternat

9、ives of system design scheme, and specify the scheme that shall be used .對(duì)本軟件系統(tǒng)的幾種設(shè)計(jì)方案進(jìn)行分析、比較，并確定所采 用的方案Design Constraints 設(shè)計(jì)約束Standards compliance 遵循標(biāo)準(zhǔn)Describe standards that software system shall comply wi描1述本軟件所遵循 的標(biāo)準(zhǔn)、規(guī)范Hardware Limitations 硬件限制Describe hardware limitations of the software syst 描

10、i 述本軟件系統(tǒng)實(shí)現(xiàn)的硬 件限制Technology Limitations 技術(shù)限制Describe technology limitations of the software system述 本軟件的技術(shù)限制Other Design Considerations 其他Describe other design considerations of the software syst描述.其他有關(guān)的設(shè)計(jì)考慮Level 1 Design Description 第一層設(shè)計(jì)描述Architecture of the software system shall be described her這里

11、要描述軟件 系統(tǒng)的總體結(jié)構(gòu)。Structure chart, Hierarchical decomposition diagram, natural language can be used to represent the architecture?體結(jié)構(gòu)描述可以使用結(jié)構(gòu)圖，層次分解圖， 自然語(yǔ)言。Decomposition Description 分解描述Module/Subsystem Decomposition模 塊/子系統(tǒng)分解This section describes subsystems , module in the systel節(jié)描述系統(tǒng)中的 子系統(tǒng)和模塊。Module/Su

12、bsystem 1 Description模 塊/子系統(tǒng)1描述Describe as follows按照以下格式描述：Identification 標(biāo)識(shí)：Type類型：Purpose目 的：Functions功能列表：Sub modules：子模塊：If this module will be further decomposed into sub modules, list all sub modules here如果本模塊還要繼續(xù)劃分，列出下屬子模塊Concurrent Process Decomposition并發(fā)進(jìn)程處理分解This section describes concurre

13、nt processes in the syste本節(jié)描述系統(tǒng) 中的并發(fā)進(jìn)程。In case of external entities, Subordinates attribute need not be described. 對(duì)于外部實(shí)體，從屬屬性不必描述。1.Process 1 Description進(jìn)程1描述Describe as follows按照以下格式描述：Identification 標(biāo)識(shí)：Type類型：Purpose目 的：Functions功能列表：This part describes the functions to be performed in the proces

14、s. 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ìn)程中要完成的功能，如功能已經(jīng)在前面的模塊分解中有描述，則重點(diǎn)描述本 進(jìn)程完成了哪些模塊的哪些功能。Data Decomposition數(shù)據(jù)分解This section describes data stores in the syste本.節(jié)描述系統(tǒng)中的數(shù)據(jù)結(jié) 構(gòu)。E

15、xternal data entities shall not be describe.部數(shù)據(jù)實(shí)體不必描述。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 describing the data, make sure the data is the global data of the

16、 level.本章節(jié)描述本系統(tǒng)中用到的全局?jǐn)?shù)據(jù)結(jié)構(gòu)，其中至少包括各分解模塊直接訪問的數(shù) 據(jù)，被各分解模塊用來在接口中使用的結(jié)構(gòu)。描述數(shù)據(jù)時(shí)要注意該數(shù)據(jù)是否真正為本級(jí)模 塊分解的公用數(shù)據(jù)。Data Entity 1 Description數(shù) 據(jù)實(shí)體1 描述Describe as follows按照以下格式描述：Identification 標(biāo)識(shí)：Type類型：Purpose目 的：Dependency Description依賴性描述This section describes relationships among the design entities such as subsystems,

17、 data stores, modules, and processes et本節(jié)描述系統(tǒng)中的子系統(tǒng)，數(shù) 據(jù)結(jié)構(gòu)，模塊，進(jìn)程等設(shè)計(jì)實(shí)體間的關(guān)系。Structure charts, transaction diagrams, MSC, ER diagram can be used to represent dependences依賴關(guān)系描述可以使用結(jié)構(gòu)圖（交互）事務(wù)圖，消息序列圖ER 圖。Running Design 運(yùn)行設(shè)計(jì)This section describes how the modules and the processes of this design level cooperat

18、e 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. For Level 2, Function specification of the module to be decomposed sh

19、ould be covered.本章節(jié)描述本層設(shè)計(jì)的各個(gè)模塊和進(jìn)程是如何配合完成系統(tǒng)的功能需可以用消息 序列圖，（交互）事務(wù)圖，結(jié)構(gòu)圖等進(jìn)行描述可以按照處理過程進(jìn)行分節(jié)描述要注意的 是描述的內(nèi)容應(yīng)該涵蓋所郁S文檔的功能需求對(duì)于二級(jí)設(shè)計(jì)來講就是要涵蓋分解對(duì)象 模塊的功能規(guī)格Data Dependencies數(shù)據(jù)依賴關(guān)系This section describes relationships among data stores本節(jié)描述數(shù)據(jù)結(jié)構(gòu)間的關(guān)系。ER diagram can be used to represent dependences.依賴關(guān)系描述可以使用R圖。Interface Des

20、cription接口描述This section describes interfaces of the design entities （such as subsystem, module, process）that make up the system本節(jié)描述軟件系統(tǒng)中設(shè)計(jì)實(shí)體如子系統(tǒng)，模塊，進(jìn)程）的接口Interface files, parameter tables can be used to describe Interface. 接口描述可以使用接口文件，參數(shù)表。In case of external entities, only the interfaces relevant

21、to the software being described need be described.對(duì)于外部實(shí)體只有同被描述軟件相關(guān)的接口才需描述。Module/Subsystem Interfaces 模塊/子系統(tǒng)接口This section describes interfaces of Module/Subsystem Interf&c本節(jié)描 述模塊/子系統(tǒng)的接口。Interfaces Provided by Module/Subsystem 1 模塊/子系統(tǒng)1提供的接口For interface function, following format should be used:Int

22、erface 1:Format:Input:Output:Return: Describes the return value of the functionDescription: Describes the objective of the interface.對(duì)于接口函數(shù)，可以采用以下形式描述：接口1：形式：輸入：輸出：返回：描述返回什么。描述：總體描述該接口實(shí)現(xiàn)的目的。Process Interfaces進(jìn)程接口This section describes interfaces of process本 節(jié)描述進(jìn)程的接口。1.Process 1 Description進(jìn)程1描述The i

23、nterfaces between the processes describe the shared memory, protocol data and messages, etc.進(jìn)程間的接口主要是描述一些共享內(nèi)存，協(xié)議數(shù)據(jù)，消息等。Describe as follows按照以下格式描述：.專業(yè).專注.Identification 標(biāo)識(shí):Type類型：Purpose目 的：Functions功能列表：Level 2 Design Description ( Optional )第二層設(shè)計(jì)描述(可選)Each entity that is defined in L1 and identifi

24、ed for further description shall be described by separate sub-sections as mentioned below中I定 義的每個(gè)實(shí) 體的進(jìn)一步設(shè)計(jì)在下面的章節(jié)進(jìn)行描述。This will be repeated for each module as follows (Same as Level 1). The detailed suggestions are also the same as Level 1.對(duì)每個(gè)模塊重復(fù)使用下述的格式和一層設(shè)計(jì)一樣。具體的編寫建議參見第一層設(shè)計(jì)Module name (1)模塊1名稱Decom

25、position Description 分解描述1.Module/Subsystem Decomposition模 塊/子系統(tǒng)分解Module/Subsystem 1 Description模 塊/子系統(tǒng)1描述Module/Subsystem 2 Description模 塊/子系統(tǒng)2描述4* 4* 4* 4* 4* 4* *Concurrent Process Decomposition并 發(fā)進(jìn)程處理分解Process 1 Description進(jìn)程1描述Process 2 Description進(jìn)程2描述4* 4* 4* 4* 4* 4* *Data Decomposition 數(shù)據(jù)分解

26、Data Entity 1 Description 數(shù)據(jù)實(shí)體1 描述Data Entity 2 Description 數(shù)據(jù)實(shí)體2描述4* 4* 4* 4* 4* 4* *Dependency Description 依賴性描述Running Design 運(yùn)行設(shè)計(jì)Data Dependencies數(shù)據(jù)依賴關(guān)系*Interface Description 接口描述1.Module/Subsystem Interfaces 模塊/子系統(tǒng)接口Interfaces Provided by Module/Subsystem 1 模塊/子系統(tǒng)1提供的接口Interfaces Provided by Mo

27、dule/Subsystem 2 模塊/子系統(tǒng)2提供的接口4* 4* 4* 4* 4* 4* *Process Interfaces 進(jìn)程接口Process 1 Description進(jìn)程1描述Process 1 Description進(jìn)程1描述4* 4* 4* 4* 4* 4*Module name (2)模塊2名稱4* 4* 4* 4* 4* 4*Configuration and Control (Optional )配置和控制(可選)Startup 啟動(dòng)Describes the steps to start up a module描述啟動(dòng)一個(gè)模塊的步驟Closing 關(guān)閉Descri

28、bes the steps to close a module描述關(guān)閉一個(gè)模塊的步驟Creating MIB Table Item MIB表項(xiàng)的創(chuàng)建Steps to create a new table item. The title of this section can be modified. 創(chuàng)建新表項(xiàng)的動(dòng)作步驟。該節(jié)的標(biāo)題可以適當(dāng)更改Deleting MIB Table Item MIB表項(xiàng)的刪除Steps to delete a table item. The title of this section can be modified.刪除表項(xiàng)的動(dòng)作步驟該節(jié)的標(biāo)題可以適當(dāng)更改Mod

29、ifying MIB Table Item MIB 表項(xiàng)的更改Steps to modify a table item. The title of this section can be modified. 修改表項(xiàng)的動(dòng)作步驟該節(jié)的標(biāo)題可以適當(dāng)更改。Database （Optional）數(shù)據(jù)庫(kù)（可選）Entity, Attributes and their relationships 實(shí)體、屬性及它們之間 的關(guān)系This section could list all the entities such as data stores, a verbose description of what

30、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 specified. All specific constraints for that entity and its relationship with other entities should also be note

31、d.本節(jié)列出所有的數(shù)據(jù)存儲(chǔ)類的實(shí)體，詳細(xì)描述實(shí)體的內(nèi)容和并列出全部屬性。對(duì)每個(gè) 屬性，詳細(xì)描述其數(shù)據(jù)庫(kù)、數(shù)據(jù)大小、特定約束。實(shí)體的所有約束及實(shí)體間的關(guān)系也要注 明。E-R diagram 實(shí)體關(guān)系 圖This section should display the E-R diagram for all the entities listed above.本節(jié)描述關(guān)于上節(jié)提到的所有實(shí)體E-R圖3 Detailed Design 詳細(xì)設(shè)計(jì)This section should focus on the description of the detailed design of the softwa

32、re entities that are a part of the software being described by the HLD Specification.對(duì)于在概要設(shè)計(jì)說明書中給出的軟件實(shí)體，本節(jié)集中描述它們的詳細(xì)描述部分。Module 1 Detail Design 模塊1詳細(xì)設(shè)計(jì)Describe data that defined or used in the module, including：Simple data i.e. global variable, constant or macro within the module；Complex data i.e. St

33、ructure or union.描述模塊中定義和使用的數(shù)據(jù)，包括：簡(jiǎn)單數(shù)據(jù)，如模塊級(jí)的全局變量、常量、宏；復(fù)合數(shù)據(jù)，如模塊內(nèi)部的結(jié)構(gòu)、聯(lián)合.；Data Description 數(shù)據(jù)描述Describe simple variables, constant or macro of the module in sub-section 1；Describe complex data from sub-section 2, such as structure, union；在1中描述本模塊中的簡(jiǎn)單變量、常量、宏；從第2部分起描述本模塊中的復(fù)合數(shù)據(jù)，如結(jié)構(gòu)、聯(lián)合等；Simple Data Descri

34、ption 簡(jiǎn)單數(shù)據(jù)描述；describe simple variable、s constant or macro used or defined in this module； 描述在本模塊中定義和使用的簡(jiǎn)單變量、常量、宏；Describes simple variables, constants used or defined in this module；The description of simple data should follow the format below：Function Description： Describing the usage of the dataDa

35、ta Definition： Defining the data按照下列格式進(jìn)行簡(jiǎn)單數(shù)據(jù)的描述功能描述：描述該數(shù)據(jù)的用途數(shù)據(jù)定義：定義該數(shù)據(jù)Structure 1 結(jié)構(gòu)1Define and describe the Data structure (include union)定義和說明該數(shù)據(jù)結(jié)構(gòu)包括聯(lián)含;The description of data structure should follow the format below:Data Structure Description: Describing the usage of the data structureData Struct

36、ure Definition: Defining the data structure with the actual programming languageData Items Description:Data TypeData Item DefinitionData Item Description按照下列格式進(jìn)行數(shù)據(jù)結(jié)構(gòu)的描述數(shù)據(jù)結(jié)構(gòu)描述：描述該數(shù)據(jù)結(jié)構(gòu)的用途數(shù)據(jù)結(jié)構(gòu)定義：用實(shí)際的編程語(yǔ)言定義該數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)項(xiàng)描述：Function Description 函數(shù)描述This section should follow the format below:Identification: Ti

37、tle of the moduleType: Type of the module, for example, the module in Level 2 Design, the process in Level 1 Design, etc.Function Description： Describing the functions of the module in brief, which should be consistent with the related section of the HLD documents.Function Invoking Relation: Using t

38、he Hierarchy Chart or Structure Chart to describe it, for example:本節(jié)應(yīng)按照下列格式進(jìn)行描述：標(biāo)識(shí)：模塊名稱類型：模塊類型，如，2級(jí)設(shè)計(jì)中的模塊，1級(jí)設(shè)計(jì)中的進(jìn)程功能概述：簡(jiǎn)要描述本模塊功能，要和概要設(shè)計(jì)文檔中相關(guān)模塊分解的描述一致。函數(shù)調(diào)用關(guān)系用層次圖或結(jié)構(gòu)圖的方式描述函數(shù)調(diào)用關(guān)系，如：圖1 Module 1 Structure Chart 模塊1結(jié)構(gòu)圖 Function 1 函數(shù)1Descript thefunction 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:/ descri