需求分析說明書、詳細(xì)設(shè)計(jì)說明書、概要設(shè)計(jì)說明書樣例

ouyang0322

以下是需求分析說明書、詳細(xì)設(shè)計(jì)說明書、概要設(shè)計(jì)說明書樣例
需要詳細(xì)資料的去
http://bbs.csai.cn/BBS/view.asp?ID={CA9329C0-93C5-4417-9170-452FF61E8CDB}&page=1下載

XX系統(tǒng)概要設(shè)計(jì)說明書

目錄

1. 文檔介紹 1

1.1 文檔目的 1

1.2 文檔范圍 1

1.3 讀者對(duì)象 1

1.4 參考文獻(xiàn) 1

1.5 術(shù)語與縮寫解釋 1

2. 系統(tǒng)概述 2

3. 設(shè)計(jì)約束 2

3.1需求約束 2

3.2隱含約束 2

4. 設(shè)計(jì)策略 3

4.1擴(kuò)展策略 3

4.2復(fù)用策略 3

4.3折衷策略 3

5．系統(tǒng)總體結(jié)構(gòu) 3

5.1、系統(tǒng)總體結(jié)構(gòu) 3

5.2、子系統(tǒng)功能及接口 4

6. 子系統(tǒng)的結(jié)構(gòu)與功能 5

6.1、TERMSERV 5

7. 功能需求追溯 5

8. 環(huán)境的配置 5

9．其它 6

附錄 6

A、 與主機(jī)接口 6

B、與終端接口 6

1. 文檔介紹

1.1 文檔目的

　　編寫該文檔的目的在于從總體設(shè)計(jì)的角度明確xxxx系統(tǒng)的功能和處理模式，明確與銀聯(lián)的接口，使系

統(tǒng)開發(fā)人員和產(chǎn)品管理人員明確產(chǎn)品功能，可以有針對(duì)性的進(jìn)行系統(tǒng)開發(fā)、測試、驗(yàn)收等各方面的工作。

1.2 文檔范圍

1.3 讀者對(duì)象

該文檔的讀者為用戶代表、軟件分析人員、開發(fā)管理人員和測試人員。

1.4 參考文獻(xiàn)

《xxxx系統(tǒng)需求說明書》

　　

1.5 術(shù)語與縮寫解釋

無

2. 系統(tǒng)概述

　　XX系統(tǒng)是以觸摸屏為主要交互工具，幫助用戶以自助方式做業(yè)務(wù)查詢。本系統(tǒng)的主要功能包括：話費(fèi)

查詢、新業(yè)務(wù)介紹、網(wǎng)點(diǎn)分布查詢、自助終端分布查詢、電信新聞、交易監(jiān)控、設(shè)備維護(hù)和監(jiān)控等。本系

統(tǒng)的設(shè)計(jì)目標(biāo)是保證系統(tǒng)可以7*24小時(shí)安全、高效無故障運(yùn)行；業(yè)務(wù)人員可以輕松完成設(shè)備和交易的監(jiān)控

、管理工作；報(bào)表種類齊全，可以滿足業(yè)務(wù)人員各種帳務(wù)需求。

3. 設(shè)計(jì)約束

3.1需求約束

* 本系統(tǒng)應(yīng)當(dāng)遵循的標(biāo)準(zhǔn)

數(shù)據(jù)命名的規(guī)則遵循《C語言編程規(guī)約》中相關(guān)的規(guī)定；

* 軟、硬件環(huán)境

本系統(tǒng)共包括聯(lián)機(jī)處理和系統(tǒng)監(jiān)控2大模塊。

聯(lián)機(jī)模塊基于C/S結(jié)構(gòu)，采用AIX操作系統(tǒng)，informix數(shù)據(jù)庫，用ESQL/C語言開發(fā)，服務(wù)器采用PC

SERVER；

監(jiān)控模塊基于B/S結(jié)構(gòu)，采用WIN9X/2000/XP操作系統(tǒng)，使用ASP.NET開發(fā)。

* 接口/協(xié)議

系統(tǒng)與自助終端和電信主機(jī)之間的通訊使用TCP/IP協(xié)議；

與自助終端的接口見附錄A、與自助終端接口

與電信主機(jī)的接口見附錄B、與電信接口

* 用戶界面

監(jiān)控部分使用WINDOWS圖形化界面，保證中專以上文化程度的人員可以無障礙操作。

* 軟件質(zhì)量

正確性：系統(tǒng)必須交易能夠被正確處理；

健壯性：系統(tǒng)應(yīng)能夠7*24小時(shí)無故障運(yùn)行；

效率：系統(tǒng)可以支持100個(gè)終端同時(shí)發(fā)起交易，處理交易的時(shí)間不超過10秒鐘；

易用性：監(jiān)控界面應(yīng)采用圖形化操作方式，便于業(yè)務(wù)人員操作；

安全性：報(bào)文中的關(guān)鍵數(shù)據(jù)域以密文的方式傳輸；

可擴(kuò)展性：應(yīng)該充分考慮到將來交易的修改或增加，避免需求變更時(shí)大規(guī)模修改程序；

3.2隱含約束

　　使用監(jiān)控管理功能的人員是銀行的業(yè)務(wù)人員，他們具有較強(qiáng)的業(yè)務(wù)技能和基本的電腦知識(shí)，對(duì)他們提

供的操作界面應(yīng)保證他們經(jīng)過簡單培訓(xùn)后無障礙的操作；

報(bào)表應(yīng)該可以在多種操作系統(tǒng)上瀏覽、打��；

系統(tǒng)應(yīng)提供審記追蹤功能；

　　應(yīng)該把有可能變動(dòng)的參數(shù)存放到配置文件或數(shù)據(jù)庫中，保證修改參數(shù)的靈活性。



4. 設(shè)計(jì)策略

4.1擴(kuò)展策略

　　該系統(tǒng)是事務(wù)處理型系統(tǒng)，將來功能的擴(kuò)展主要是指增加新的交易。為了方便本系統(tǒng)在將來擴(kuò)展功能

，在做系統(tǒng)設(shè)計(jì)時(shí)應(yīng)采取如下策略：

　　為了保證增加新的功能或接口變更時(shí)程序改動(dòng)規(guī)模最小化，應(yīng)該使用報(bào)文格式配置文件解析、組織報(bào)

文；

　　為了保證系統(tǒng)的靈活性，應(yīng)該把可變參數(shù)保存到配置文件中；

XX系統(tǒng)詳細(xì)設(shè)計(jì)說明書



目錄

第一章 引言 1

1.1 概述 1

1.2 背景 1

1.3 定義 1

1.4 參考資料 1

1.5 術(shù)語與縮寫解釋 1

2. 程序結(jié)構(gòu) 2

2.1 模塊匯總表 2

3. 程序設(shè)計(jì)說明 2

3.1 終端通訊子系統(tǒng) 2

3.1.1 子系統(tǒng)功能說明 2

3.1.2 子系統(tǒng)流程圖 3

3.1.3 子系統(tǒng)模塊設(shè)計(jì)說明 5

4. 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 5

4.1 終端檔案表 TERMFILE 5

5. 接口設(shè)計(jì) 5

5.1 與自助設(shè)備接口 5

5.2 與主機(jī)接口 6

5.3 內(nèi)部接口 6

第一章 引言

1.1 概述

　　編寫

XX產(chǎn)品詳細(xì)設(shè)計(jì)說明書的目的在于從詳細(xì)設(shè)計(jì)的角度明確XX項(xiàng)目的業(yè)務(wù)品種、功能范圍，明確與業(yè)務(wù)主機(jī)

/終端系統(tǒng)的接口和業(yè)務(wù)處理模式，使系統(tǒng)開發(fā)人員和產(chǎn)品管理人員明確產(chǎn)品功能，可以有針對(duì)性的進(jìn)行

系統(tǒng)開發(fā)、測試、驗(yàn)收等各方面的工作。

1.2 背景

　　系統(tǒng)名稱：XX系統(tǒng)

　　任務(wù)提出者：XXX

　　開發(fā)者：XX部門

　　用戶：XX電信

1.3 定義

1.4 參考資料

　　《項(xiàng)目開發(fā)計(jì)劃書》

　　《產(chǎn)品需求分析說明書》

　　《系統(tǒng)總體設(shè)計(jì)說明書》

1.5 術(shù)語與縮寫解釋

　　

2. 程序結(jié)構(gòu)

2.1 模塊匯總表

終端通訊子系統(tǒng)模塊名稱功能簡述readdata接收終端請(qǐng)求報(bào)文writelog把報(bào)文寫入日志setsockscoket設(shè)

置解析/組織報(bào)文以及報(bào)文分流模塊名稱功能簡述unpack_c解析終端請(qǐng)求報(bào)文printstruct_c輸出解吸后的

報(bào)文checkpackage報(bào)文合法性檢查pack_c組織應(yīng)答報(bào)文：：：：

3. 程序設(shè)計(jì)說明

3.1 終端通訊子系統(tǒng)

3.1.1 子系統(tǒng)功能說明

　　建立TCP/IP 服務(wù)器偵聽從來自自助設(shè)備端的連接請(qǐng)求。

　　為一個(gè)偵聽到的連接創(chuàng)建一個(gè)進(jìn)程，負(fù)責(zé)該連接上的接收和發(fā)送，并將接收和發(fā)送的原始數(shù)據(jù)寫入

LOG文件。

　　將接收到的數(shù)據(jù)送到隊(duì)列1，從隊(duì)列2取數(shù)據(jù)進(jìn)行用于發(fā)送。

　　實(shí)現(xiàn)子系統(tǒng)功能程序列表：

　　termserv.c

　　子系統(tǒng)接口描述:

　　輸入：終端請(qǐng)求報(bào)文、解析/組織報(bào)文以及報(bào)文分流模塊產(chǎn)生的應(yīng)答報(bào)文

輸出：向解析/組織報(bào)文以及報(bào)文分流模塊輸出終端請(qǐng)求報(bào)文、向終端輸出應(yīng)答報(bào)文、向日志文件輸出接

收到的數(shù)據(jù)

3.1.2 子系統(tǒng)流程圖



第一章 引言.... 1

1.1 編寫目的... 1

1.2 項(xiàng)目背景... 1

1.3 基本定義... 1

第二章 產(chǎn)品概述.... 2

2.1 系統(tǒng)功能... 2

2.2 運(yùn)行環(huán)境... 2

2.3 用戶的特點(diǎn)... 2

2.3 條件與限制... 2

第三章 功能需求.... 3

3.1 功能劃分... 3

3.2 功能描述... 3

4.3 軟件接口... 4

4.4 故障處理... 4

第四章 其它需求.... 5

4.1 應(yīng)用環(huán)境... 5

4.2 其它要求... 5



第一章 引言

1.1 編寫目的

編寫該文檔的目的在于明確XX系統(tǒng)的用戶需求，使得軟件開發(fā)人員與用戶對(duì)待開發(fā)軟件的需求有統(tǒng)一的、

無二義性的認(rèn)識(shí)。該文檔所描述的內(nèi)容，可作為軟件確認(rèn)測試的依據(jù)。該文檔的讀者為用戶代表、軟件分

析人員、開發(fā)管理人員和測試人員。

1.2 項(xiàng)目背景

見《XX項(xiàng)目啟動(dòng)會(huì)議記要》

1.3 基本定義



第二章 產(chǎn)品概述

2.1 系統(tǒng)功能

序號(hào)

功能名稱

優(yōu)先級(jí)

簡要描述



1聯(lián)機(jī)功能

高

解決實(shí)時(shí)交易問題



2管理監(jiān)控功能

高

解決終端日常維護(hù)問題


2.2 運(yùn)行環(huán)境

軟件平臺(tái)：服務(wù)器為AIX UNIX 4.3.3操作系統(tǒng)、informix數(shù)據(jù)庫；

監(jiān)控端為WINDONS 98/2000/XP操作系統(tǒng)。

硬件平臺(tái)：服務(wù)器為IBM RS6000系列主機(jī)；

監(jiān)控端為PC機(jī)。

2.3 用戶的特點(diǎn)

由于使用自助終端的人員是廣大市民，所以自助終端的操作界面應(yīng)滿足初中以上文化程度的人無障礙的操

作；

使用監(jiān)控管理功能的人員是業(yè)務(wù)人員，他們具有較強(qiáng)的業(yè)務(wù)技能和基本的電腦知識(shí)，對(duì)他們提供的操作界

面應(yīng)保證他們經(jīng)過培訓(xùn)后無障礙的操作。



2.3 條件與限制

本次開發(fā)的期限為2002-2-5開始，2002-3-5結(jié)束；

議采用SOCKET通訊協(xié)議；

主機(jī)端的接口由主機(jī)端給出，不可更改；

與終端的接口由公司與終端廠家協(xié)商。
需要詳細(xì)資料的去
http://bbs.csai.cn/BBS/view.asp?ID={CA9329C0-93C5-4417-9170-452FF61E8CDB}&page=1下載

小菜9527

我這邊接口說明書是單獨(dú)的文檔米有附錄在概設(shè)里面，原因是需求評(píng)審和設(shè)計(jì)評(píng)審是兩個(gè)階段
單獨(dú)成立文檔便于以后開發(fā)過程中版本升級(jí)！哈哈
我覺的第三方的接口是不是應(yīng)該算是需求，因?yàn)楫吘故莿e人提供的東西了！

山中無老虎

原帖由 小菜9527 于 2007-1-18 09:37 發(fā)表
我這邊接口說明書是單獨(dú)的文檔米有附錄在概設(shè)里面，原因是需求評(píng)審和設(shè)計(jì)評(píng)審是兩個(gè)階段
單獨(dú)成立文檔便于以后開發(fā)過程中版本升級(jí)！哈哈
我覺的第三方的接口是不是應(yīng)該算是需求，因?yàn)楫吘故莿e人提供的東西了！

概念好象有些問題。你說的第三方接口是指什么呢？

山中無老虎

我覺得這些東西都是活的，沒有必要非按一定的格式來說明。

la.lune

這個(gè)沒什么規(guī)格了 產(chǎn)品不同 行業(yè)不同  流程大相徑庭
每個(gè)公司都有自己一套流程 當(dāng)然spec差的就更遠(yuǎn)了
一般只要能行的通 以后的工作可以順利進(jìn)行就OK

zsj_0927

寫過及個(gè)概要設(shè)計(jì)，但都是按照自己想法寫的。

sytpb

mark

leoflash

{:2_166:}{:2_167:}{:2_167:}{:2_167:}

blackuhlan

組織過程資產(chǎn)應(yīng)該包括這些文檔模板，至于如何寫，怎么樣才算寫好了，由最佳實(shí)踐來指導(dǎo)。不同的企業(yè)，為了企業(yè)內(nèi)部規(guī)范的統(tǒng)一，交流方便等原因，會(huì)制定不同的模板。況且，對(duì)于大的項(xiàng)目和小的項(xiàng)目，就算是同樣目的的一個(gè)文檔，也可能會(huì)寫成不同的形式。