程序設(shè)計(jì)-詳細(xì)設(shè)計(jì)模板

1、（文檔名稱）福州星網(wǎng)視易信息系統(tǒng)XXX更新記錄：版本整理日期內(nèi)容10蔡炆炆2010-11-3后臺(tái)系統(tǒng)詳細(xì)設(shè)計(jì)模板1.1蔡炆炆2010-11-5調(diào)整設(shè)計(jì)說(shuō)明結(jié)構(gòu)目錄一、引言21.編寫目的22.適用范圍23.文檔概述24.術(shù)語(yǔ)、定義和縮寫2二、系統(tǒng)結(jié)構(gòu)21.軟件結(jié)構(gòu)22.程序結(jié)構(gòu)23.關(guān)鍵技術(shù)2三、設(shè)計(jì)說(shuō)明21.程序模塊12l需求描述2l功能2l界面設(shè)計(jì)2l輸入項(xiàng)2l輸出項(xiàng)2l處理邏輯2l接口2l出入口參數(shù)2l限制條件2l測(cè)試要點(diǎn)22.程序模塊22l需求描述2l功能2l界面設(shè)計(jì)2l輸入項(xiàng)2l輸出項(xiàng)2l處理邏輯2l接口2l出入口參數(shù)2l限制條件2l測(cè)試要點(diǎn)26 / 8一、 引言1. 編寫目的本文檔作

2、為*與XXXXXXXXXX公司之間就*建立XXXX司（局或單位）XXXXXXXXXX系統(tǒng)需求理解達(dá)成一致共識(shí)的基礎(chǔ)文件，作為雙方界定項(xiàng)目范圍、簽定合同的主要基礎(chǔ)，也作為本項(xiàng)目驗(yàn)收的主要依據(jù)。同時(shí)，本文檔也作為*XXX后繼工作開展的基礎(chǔ)，供雙方項(xiàng)目主管負(fù)責(zé)人、項(xiàng)目經(jīng)理、技術(shù)開發(fā)人員、測(cè)試人員等理解需求之用。2. 適用范圍本文檔適用于所有與本項(xiàng)目有關(guān)的軟件開發(fā)階段及其相關(guān)人員，其中：*方面的項(xiàng)目負(fù)責(zé)人、公司方項(xiàng)目經(jīng)理、技術(shù)開發(fā)人員（包括分析人員、設(shè)計(jì)人員、程序人員）、測(cè)試人員應(yīng)重點(diǎn)閱讀本文檔各部分，其他人員可選擇性閱讀本文檔。3. 文檔概述本文檔主要描述了XXXXXXXXXX系統(tǒng)項(xiàng)目的軟件詳細(xì)設(shè)計(jì)

3、的內(nèi)容。本文檔首先從軟件結(jié)構(gòu)、關(guān)鍵技術(shù)、程序結(jié)構(gòu)等方面概要描述系統(tǒng)，然后進(jìn)一步詳細(xì)描述每一個(gè)程序模塊的設(shè)計(jì)說(shuō)明。4. 術(shù)語(yǔ)、定義和縮寫列出本文檔所涉及的專業(yè)術(shù)語(yǔ)、縮寫詞及相關(guān)定義。定義所有必要的術(shù)語(yǔ)，以便讀者可以正確地解釋軟件需求規(guī)格說(shuō)明，包括詞頭和縮寫。你可能希望為整個(gè)公司創(chuàng)建一張跨越多項(xiàng)項(xiàng)目的詞匯表，并且只包括特定于單一項(xiàng)目的軟件需求規(guī)格說(shuō)明中的術(shù)語(yǔ)。示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。1) OLTP：On-line Transaction Processing，聯(lián)機(jī)事務(wù)處理。2) OLAP：On-Line Analytical Processing，聯(lián)機(jī)分析處理；是使分析人員、管理人

4、員或執(zhí)行人員能夠從多角度對(duì)信息進(jìn)行快速、一致、交互地存取,從而獲得對(duì)數(shù)據(jù)的更深入了解的一類軟件技術(shù)。二、 系統(tǒng)結(jié)構(gòu)1. 軟件結(jié)構(gòu)用一系列圖表形式給出軟件系統(tǒng)結(jié)構(gòu)。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。金融快報(bào)系統(tǒng)的實(shí)現(xiàn)由日常任務(wù)、系統(tǒng)維護(hù)、規(guī)則維護(hù)、工作向?qū)膫€(gè)部分來(lái)完成。日常任務(wù)是日程工作的任務(wù)，及時(shí)了解當(dāng)前任務(wù)和任務(wù)狀態(tài)的展示頁(yè)面。在這里有查看報(bào)送情況，它將會(huì)查看到文件的是否報(bào)送；數(shù)據(jù)查看修改是指數(shù)據(jù)由于某種原因錯(cuò)誤，可進(jìn)行修改的功能；上報(bào)數(shù)據(jù)狀態(tài)是指報(bào)送的文件報(bào)送完后，文件被鎖定，如果要修改，需要對(duì)文件進(jìn)行解鎖；快報(bào)生成下載是指數(shù)據(jù)接收完畢后，生成金融快報(bào)完，可以下載瀏覽。系統(tǒng)維護(hù)是

5、用戶對(duì)本系統(tǒng)的維護(hù)，包括快報(bào)版本管理、文件信息管理、報(bào)表信息管理、文件內(nèi)容管理、指標(biāo)信息管理。規(guī)則維護(hù)是用戶對(duì)本系統(tǒng)規(guī)則的維護(hù)，包括收數(shù)模板管理、報(bào)表模板管理、報(bào)送規(guī)則管理。工作向?qū)康氖亲層脩舨挥脤W(xué)習(xí)本軟件，就能完成工作流程而開發(fā)的工作向?qū)Чδ?。以提示語(yǔ)的形式來(lái)引導(dǎo)工作流程。工作向?qū)怯扇粘９ぷ飨驅(qū)?、快?bào)定制向?qū)?、?shù)據(jù)采集向?qū)?. 程序結(jié)構(gòu)用一系列圖表形式列出軟件系統(tǒng)每個(gè)程序模塊（或部件）名稱、標(biāo)識(shí)符以及這些程序模塊之間的層次關(guān)系。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容3. 關(guān)鍵技術(shù)從技術(shù)角度說(shuō)明如何來(lái)實(shí)現(xiàn)新應(yīng)用系統(tǒng)，采取哪些技術(shù)，如何確保技術(shù)實(shí)現(xiàn)。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容

6、。三、 設(shè)計(jì)說(shuō)明從本章節(jié)開始，逐個(gè)地給出各個(gè)層次中的每個(gè)程序模塊的設(shè)計(jì)考慮。以下給出的提綱是針對(duì)一般情況的。對(duì)于一個(gè)具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的內(nèi)容往往與它所隸屬的上一層模塊的對(duì)應(yīng)條目的內(nèi)容相同，在這種情況下，只要簡(jiǎn)單地說(shuō)明這一點(diǎn)即可。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。該系統(tǒng)的總體設(shè)計(jì)思路是采用B/S結(jié)構(gòu)，通過(guò)WEB實(shí)現(xiàn)金融快報(bào)信息管理，利用Web Service和SOAP協(xié)議來(lái)和交換平臺(tái)傳輸數(shù)據(jù)，實(shí)現(xiàn)在線填報(bào)數(shù)據(jù)、修改數(shù)據(jù)、在線生成快報(bào)、在線下載的金融快報(bào)的整個(gè)過(guò)程，數(shù)據(jù)層是通過(guò)SQL Server數(shù)據(jù)庫(kù)構(gòu)建。系統(tǒng)的用例列表如下：下面，將按照用例逐項(xiàng)給出對(duì)

7、用例的設(shè)計(jì)實(shí)現(xiàn)1. 程序模塊1標(biāo)識(shí)、名稱、簡(jiǎn)要描述。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。l 需求描述簡(jiǎn)要描述該模塊或部件或類的業(yè)務(wù)需求，并標(biāo)明需求來(lái)源（對(duì)應(yīng)于需求規(guī)格說(shuō)明書）。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。查看報(bào)送情況是根據(jù)用戶輸入來(lái)選擇時(shí)間，來(lái)查詢文件的報(bào)送情況，同時(shí)顯示文件的時(shí)間、文件的編號(hào)、文件名稱、報(bào)送的機(jī)構(gòu)、報(bào)送狀態(tài)，報(bào)送狀態(tài)欄顯示的是已經(jīng)報(bào)送，會(huì)以白色來(lái)告訴用戶文件以已經(jīng)報(bào)送，報(bào)送狀態(tài)欄顯示的是尚未報(bào)送，會(huì)以黃褐色來(lái)告訴用戶文件以尚未報(bào)送l 功能詳細(xì)說(shuō)明此程序模塊所要實(shí)現(xiàn)的主要功能，如查詢、修改、刪除、添加、數(shù)據(jù)處理等。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。該

8、模塊要實(shí)現(xiàn)用戶查看報(bào)送文件的是否接收的狀態(tài)。l 界面設(shè)計(jì)首先，可將交互的情況在紙面上列出，并用圖形工具（如Visio）畫出系統(tǒng)中的合理的用戶界面。進(jìn)一步，可使用開發(fā)工具實(shí)現(xiàn)可運(yùn)行的原型，請(qǐng)用戶體驗(yàn)原型，收集反饋，及時(shí)改進(jìn)。詳細(xì)設(shè)計(jì)階段不需要太關(guān)注美術(shù)效果等附加的細(xì)節(jié)，主要在于系統(tǒng)與用戶交互的方式。l 輸入項(xiàng)描述輸入項(xiàng)的特性，包括：名稱、標(biāo)識(shí)、數(shù)據(jù)類型、數(shù)據(jù)格式、完整性檢測(cè)（數(shù)值的有效范圍）、輸入方式、輸入數(shù)據(jù)的來(lái)源等。并說(shuō)明采用什么樣的輸入方式（如采用下拉式列表等），輸入項(xiàng)的分組方式和界面安排，以保證輸入的方便。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。用戶通過(guò)輸入時(shí)間條件，查詢快報(bào)生成情況。

9、1）數(shù)據(jù)時(shí)間（選入項(xiàng)）不可為空；2）快報(bào)版本（選入項(xiàng)）不可為空；3）期號(hào)（填入項(xiàng)）不可為空；4）報(bào)表時(shí)間（選入項(xiàng)）不可為空。l 輸出項(xiàng)描述輸出項(xiàng)的特性，包括：名稱、標(biāo)識(shí)、數(shù)據(jù)類型、數(shù)據(jù)格式、數(shù)值的有效范圍、輸出方式及其說(shuō)明等。若輸出方式采用屏幕查詢方式，應(yīng)說(shuō)明需要對(duì)什么數(shù)據(jù)項(xiàng)進(jìn)行什么樣的查詢，查詢輸出格式，仔細(xì)說(shuō)明查詢?cè)O(shè)計(jì)要點(diǎn)。若輸出方式采用數(shù)據(jù)打印方式，應(yīng)說(shuō)明需要打印什么數(shù)據(jù)以及要求的打印方式。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。（1）點(diǎn)擊“查看生成情況”，會(huì)輸出當(dāng)天時(shí)間的快報(bào)生成情況。 文件時(shí)間 快報(bào)版本 版本描述 文件狀態(tài) WORD下載 EXCEL下載(2)點(diǎn)擊“查看歷史快報(bào)”，會(huì)

10、輸出所有生成快報(bào)生成情況。 文件時(shí)間 快報(bào)版本 版本描述 文件狀態(tài) WORD下載 EXCEL下載（3）點(diǎn)擊“生成快報(bào)”，會(huì)輸出進(jìn)度條“快報(bào)正在生成中”。（4）點(diǎn)擊“WORD下載”，會(huì)輸出快報(bào)文件，以WORD形式輸出。l 處理邏輯可根據(jù)實(shí)際需要，用圖表（如流程圖）或者過(guò)程描述語(yǔ)言來(lái)表示本程序所作的處理邏輯流程。可包括正常處理流程、異常處理流程和備用操作流程。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容l 接口可根據(jù)實(shí)際需要，分別列出和此模塊有調(diào)用關(guān)系的所有模塊及其調(diào)用關(guān)系，描述與此模塊有關(guān)的數(shù)據(jù)結(jié)構(gòu)以及基表、視圖等數(shù)據(jù)庫(kù)對(duì)象，說(shuō)明其名稱及其中文描述。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。l 出入

11、口參數(shù)可根據(jù)實(shí)際需要，詳細(xì)描述本程序模塊所有的出入口參數(shù)，包括參數(shù)內(nèi)容、參數(shù)類型、參數(shù)描述等。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。l 限制條件可根據(jù)實(shí)際需要，說(shuō)明此程序運(yùn)行所受到的限制條件（或約束）。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。l 測(cè)試要點(diǎn)可根據(jù)測(cè)試需要，簡(jiǎn)要給出測(cè)試本程序的主要測(cè)試要求，如測(cè)試功能項(xiàng)、輸入項(xiàng)的完整性檢測(cè)、數(shù)據(jù)處理的正確性、測(cè)試的注意點(diǎn)等。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。2. 程序模塊2標(biāo)識(shí)、名稱、簡(jiǎn)要描述。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。l 需求描述簡(jiǎn)要描述該模塊或部件或類的業(yè)務(wù)需求，并標(biāo)明需求來(lái)源（對(duì)應(yīng)于需求規(guī)格說(shuō)明書）。 示范：僅供

12、參考，不具備任何實(shí)質(zhì)性的內(nèi)容。查看報(bào)送情況是根據(jù)用戶輸入來(lái)選擇時(shí)間，來(lái)查詢文件的報(bào)送情況，同時(shí)顯示文件的時(shí)間、文件的編號(hào)、文件名稱、報(bào)送的機(jī)構(gòu)、報(bào)送狀態(tài)，報(bào)送狀態(tài)欄顯示的是已經(jīng)報(bào)送，會(huì)以白色來(lái)告訴用戶文件以已經(jīng)報(bào)送，報(bào)送狀態(tài)欄顯示的是尚未報(bào)送，會(huì)以黃褐色來(lái)告訴用戶文件以尚未報(bào)送l 功能詳細(xì)說(shuō)明此程序模塊所要實(shí)現(xiàn)的主要功能，如查詢、修改、刪除、添加、數(shù)據(jù)處理等。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。該模塊要實(shí)現(xiàn)用戶查看報(bào)送文件的是否接收的狀態(tài)。l 界面設(shè)計(jì)首先，可將交互的情況在紙面上列出，并用圖形工具（如Visio）畫出系統(tǒng)中的合理的用戶界面。進(jìn)一步，可使用開發(fā)工具實(shí)現(xiàn)可運(yùn)行的原型，請(qǐng)用戶體

13、驗(yàn)原型，收集反饋，及時(shí)改進(jìn)。詳細(xì)設(shè)計(jì)階段不需要太關(guān)注美術(shù)效果等附加的細(xì)節(jié)，主要在于系統(tǒng)與用戶交互的方式。l 輸入項(xiàng)描述輸入項(xiàng)的特性，包括：名稱、標(biāo)識(shí)、數(shù)據(jù)類型、數(shù)據(jù)格式、完整性檢測(cè)（數(shù)值的有效范圍）、輸入方式、輸入數(shù)據(jù)的來(lái)源等。并說(shuō)明采用什么樣的輸入方式（如采用下拉式列表等），輸入項(xiàng)的分組方式和界面安排，以保證輸入的方便。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。用戶通過(guò)輸入時(shí)間條件，查詢快報(bào)生成情況。1）數(shù)據(jù)時(shí)間（選入項(xiàng)）不可為空；2）快報(bào)版本（選入項(xiàng)）不可為空；3）期號(hào)（填入項(xiàng)）不可為空；4）報(bào)表時(shí)間（選入項(xiàng)）不可為空。l 輸出項(xiàng)描述輸出項(xiàng)的特性，包括：名稱、標(biāo)識(shí)、數(shù)據(jù)類型、數(shù)據(jù)格式、數(shù)值

14、的有效范圍、輸出方式及其說(shuō)明等。若輸出方式采用屏幕查詢方式，應(yīng)說(shuō)明需要對(duì)什么數(shù)據(jù)項(xiàng)進(jìn)行什么樣的查詢，查詢輸出格式，仔細(xì)說(shuō)明查詢?cè)O(shè)計(jì)要點(diǎn)。若輸出方式采用數(shù)據(jù)打印方式，應(yīng)說(shuō)明需要打印什么數(shù)據(jù)以及要求的打印方式。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。（1）點(diǎn)擊“查看生成情況”，會(huì)輸出當(dāng)天時(shí)間的快報(bào)生成情況。 文件時(shí)間 快報(bào)版本 版本描述 文件狀態(tài) WORD下載 EXCEL下載(2)點(diǎn)擊“查看歷史快報(bào)”，會(huì)輸出所有生成快報(bào)生成情況。 文件時(shí)間 快報(bào)版本 版本描述 文件狀態(tài) WORD下載 EXCEL下載（3）點(diǎn)擊“生成快報(bào)”，會(huì)輸出進(jìn)度條“快報(bào)正在生成中”。（4）點(diǎn)擊“WORD下載”，會(huì)輸出快報(bào)文件，以WORD形式輸出。l 處理邏輯可根據(jù)實(shí)際需要，用圖表（如流程圖）或者過(guò)程描述語(yǔ)言來(lái)表示本程序所作的處理邏輯流程?？砂ㄕＬ幚砹鞒?、異常處理流程和備用操作流程。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容l 接口可根據(jù)實(shí)際需要，分別列出和此模塊有調(diào)用關(guān)系的所有模塊及其調(diào)用關(guān)系，描述與此模塊有關(guān)的數(shù)據(jù)結(jié)構(gòu)以及基表、視圖等數(shù)據(jù)庫(kù)對(duì)象，說(shuō)明其名稱及其中文描述。 示范：僅供參考，不具備任何實(shí)質(zhì)性的內(nèi)容。l 出入口參數(shù)可根據(jù)實(shí)際需要，詳細(xì)描述本程序