文檔簡(jiǎn)單范例資料

軟件開(kāi)發(fā)文檔項(xiàng)目名：''通訊錄”版本：a測(cè)試版作者：ccba編寫時(shí)間：2001-8-20文檔內(nèi)容：1需求規(guī)格說(shuō)明書(shū)2概要設(shè)計(jì)說(shuō)明書(shū)3詳細(xì)設(shè)計(jì)說(shuō)明書(shū)文檔號(hào)IM00101需求規(guī)格說(shuō)明書(shū)1、引言：1.1編寫目的本文檔的編寫是為了確定待開(kāi)發(fā)軟件的功能、性能、數(shù)據(jù)、界面的需求。1.2項(xiàng)目背景、、通訊錄”軟件是為了提供一種功能完備，易于操作、界面美觀的優(yōu)秀軟件。該軟件由蔡文亮單獨(dú)開(kāi)發(fā)完成。1.3定義需求規(guī)格說(shuō)明書(shū)采用參考資料②標(biāo)準(zhǔn)1.4參考資料薛華成《管理信息系統(tǒng)（第三版）》清華大學(xué)出版社1999.5鄭人杰、殷人昆、陶永雷《實(shí)用軟件工程（第二版）》清華大學(xué)出版社1997.4周之英《現(xiàn)代軟件工程（基本方法篇）》科學(xué)出版社2000.12、功能需求該軟件由四個(gè)主功能模塊和一個(gè)擴(kuò)展功能模塊構(gòu)成，各功能模塊中規(guī)定的均為軟件的基本功能，在開(kāi)發(fā)過(guò)程中，開(kāi)發(fā)人員可根據(jù)實(shí)際情況在滿足基本功能需求的前提下增加新功能，但必須詳細(xì)編寫相關(guān)文檔。2.1錄入、修改功能模塊該功能塊主要用于數(shù)據(jù)庫(kù)的數(shù)據(jù)錄入和修改，考慮到通訊錄的實(shí)際需要，可以放松對(duì)數(shù)據(jù)庫(kù)完整性結(jié)束的控制，但從減少數(shù)據(jù)庫(kù)的角度來(lái)考慮，不容許有完全相同的紀(jì)錄出現(xiàn)（考慮的合并，相同的紀(jì)錄項(xiàng)）。2.2查詢功能塊本功能模塊是最重要的功能塊，對(duì)通訊錄的操作最主要部分就是查詢操作。本功能塊要求有如下功能：1）按數(shù)據(jù)庫(kù)各個(gè)屬性查詢2）按數(shù)據(jù)庫(kù)各個(gè)屬性之間的邏輯組合查詢?nèi)纾翰樵兠Q為''鴨子”且年齡為20歲的詳細(xì)情況（SQL語(yǔ)句表示）SELECT*FROMMESSAGERWHERENICKNAME=“鴨子”ANDAGE=203）按某一屬性的數(shù)值范圍查詢及其邏輯組如：查詢年齡在20至35歲間的詳細(xì)情況（SQL語(yǔ)句表示）SELECT*FROMMESSAGERWHEREAGEBETWEEN20AND354）模糊查詢同時(shí)我們要求查詢結(jié)果可以按用戶要求的格式來(lái)顯示，如：用戶能調(diào)整顯示屬性的個(gè)數(shù)和組合。2.3系統(tǒng)安全塊通訊錄的信息是個(gè)人隱私，故在軟件中加入必要的安全措施。主要有以下三點(diǎn)：1）登錄帳號(hào)和密碼的管理2）帳戶權(quán)限的控制3）對(duì)部分登錄帳號(hào)隱藏部分內(nèi)容2.4系統(tǒng)設(shè)置塊本部分內(nèi)容主要是對(duì)軟件使用時(shí)一些設(shè)置使其更利于軟件的使用：主要包括以下四個(gè)方面：1）系統(tǒng)界面背景和色彩設(shè)置（模仿WINNAP）2）鬧鈴功能開(kāi)關(guān)，即實(shí)現(xiàn)朋友生日提醒功能3）記錄內(nèi)容項(xiàng)（即數(shù)據(jù)庫(kù)修改通訊錄上的內(nèi)容項(xiàng)）4）歷史記錄，用戶可以選擇是否記錄下何人何時(shí)使用過(guò)該軟件2.5擴(kuò)展功能塊1）網(wǎng)絡(luò)功能：通過(guò)OLE/COM接口的調(diào)用，實(shí)現(xiàn)E-mail軟件調(diào)用。2）幫助文檔的制作（On-linehelp）3、性能需求3.1效率需求：要求軟件的啟動(dòng)時(shí)間不超過(guò)3秒，最好控制在2秒內(nèi)，每次查詢的時(shí)間不超過(guò)3秒，其它各項(xiàng)操作完成時(shí)間在1秒限內(nèi)。3.2空間需求：視數(shù)據(jù)庫(kù)大小而定，一般在10M以內(nèi)。4、數(shù)據(jù)描述4.1E-R圖4.2數(shù)據(jù)項(xiàng)數(shù)據(jù)項(xiàng)：姓名含義說(shuō)明：標(biāo)識(shí)記錄信息別名：無(wú)類型：字符串長(zhǎng)度：20取值范圍：中文字符或西文字符與其他數(shù)據(jù)項(xiàng)的邏輯關(guān)系：允許重名現(xiàn)象數(shù)據(jù)項(xiàng)：系統(tǒng)色彩標(biāo)志位含義說(shuō)明：系統(tǒng)是否有色彩設(shè)置別名：無(wú)類型：布爾型取值含義：T是F否與其他數(shù)據(jù)項(xiàng)的邏輯關(guān)系：若系統(tǒng)有色彩設(shè)置，啟用系統(tǒng)色彩數(shù)據(jù)數(shù)據(jù)項(xiàng)：系統(tǒng)色彩含義說(shuō)明：系統(tǒng)界面色彩別名：無(wú)類型：長(zhǎng)整形與其他數(shù)據(jù)項(xiàng)的邏輯關(guān)系：若系統(tǒng)有色彩設(shè)置，啟用系統(tǒng)色彩數(shù)據(jù)數(shù)據(jù)項(xiàng)：系統(tǒng)背景標(biāo)志位含義說(shuō)明：系統(tǒng)是否有背景設(shè)置別名：無(wú)類型：布爾型取值含義：T是F否與其他數(shù)據(jù)項(xiàng)的邏輯關(guān)系：若系統(tǒng)有背景設(shè)置，啟用系統(tǒng)背景數(shù)據(jù)數(shù)據(jù)項(xiàng)：系統(tǒng)背景含義說(shuō)明：系統(tǒng)界面背景別名：無(wú)類型：長(zhǎng)整形與其他數(shù)據(jù)項(xiàng)的邏輯關(guān)系：若系統(tǒng)有背景設(shè)置，啟用系統(tǒng)背景數(shù)據(jù)數(shù)據(jù)項(xiàng)：系統(tǒng)提醒功能開(kāi)關(guān)含義說(shuō)明：系統(tǒng)是否有提醒功能設(shè)置別名：無(wú)類型：布爾型數(shù)據(jù)項(xiàng)：系統(tǒng)跟蹤審計(jì)功能開(kāi)關(guān)含義說(shuō)明：系統(tǒng)是否有跟蹤審計(jì)功能設(shè)置類型：布爾型數(shù)據(jù)項(xiàng)：系統(tǒng)權(quán)限矩陣含義說(shuō)明：不同權(quán)限級(jí)別的權(quán)限設(shè)置類型：4x4布爾型矩陣數(shù)據(jù)項(xiàng)：出生日期含義說(shuō)明：記錄項(xiàng)表示的人物的出生日期類型：日期型數(shù)據(jù)項(xiàng)：性別含義說(shuō)明：記錄項(xiàng)表示的人物的性別類型：布爾型取值說(shuō)明：T男F女?dāng)?shù)據(jù)項(xiàng)：聯(lián)系方式含義說(shuō)明：記錄項(xiàng)表示的人物的聯(lián)系方式數(shù)據(jù)項(xiàng)：賬號(hào)別名：用戶賬號(hào)含義說(shuō)明：用戶登錄系統(tǒng)使用的身份鑒別碼類型：字符串長(zhǎng)度：10取值范圍：數(shù)字、中文字符和西文字符與其他數(shù)據(jù)項(xiàng)的邏輯關(guān)系：和密碼數(shù)據(jù)項(xiàng)一一對(duì)應(yīng)數(shù)據(jù)項(xiàng)：密碼別名：用戶密碼含義說(shuō)明：用戶用于登錄系統(tǒng)的和用戶賬號(hào)相應(yīng)的密碼類型：字符串長(zhǎng)度：10取值范圍：數(shù)字、中文字符和西文字符與其他數(shù)據(jù)項(xiàng)的邏輯關(guān)系：和賬號(hào)數(shù)據(jù)項(xiàng)一一對(duì)應(yīng)數(shù)據(jù)項(xiàng)：權(quán)限含義說(shuō)明：用戶賬號(hào)的權(quán)限類型：短整形與其他數(shù)據(jù)項(xiàng)的邏輯關(guān)系：權(quán)限矩陣用于設(shè)置本數(shù)據(jù)項(xiàng)4.3數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)結(jié)構(gòu)：系統(tǒng)數(shù)據(jù)含義說(shuō)明：記錄系統(tǒng)的設(shè)置數(shù)據(jù)組成：系統(tǒng)數(shù)據(jù)結(jié)構(gòu)=系統(tǒng)色彩標(biāo)志位+系統(tǒng)色彩+系統(tǒng)背景標(biāo)志位+系統(tǒng)背景+系統(tǒng)提醒功能開(kāi)關(guān)+系統(tǒng)跟蹤審計(jì)功能開(kāi)關(guān)+系統(tǒng)權(quán)限矩陣數(shù)據(jù)結(jié)構(gòu)：記錄項(xiàng)數(shù)據(jù)含義說(shuō)明：記錄通信錄中的記錄信息組成：記錄項(xiàng)數(shù)據(jù)結(jié)構(gòu)=姓名+性別+年齡+聯(lián)系方式數(shù)據(jù)結(jié)構(gòu)：用戶數(shù)據(jù)含義說(shuō)明：用戶登錄系統(tǒng)使用數(shù)據(jù)組成：用戶數(shù)據(jù)=賬號(hào)+密碼+權(quán)限4.4數(shù)據(jù)流4.5數(shù)據(jù)存儲(chǔ)注：4.數(shù)據(jù)流5.數(shù)據(jù)存儲(chǔ)略4.6主題數(shù)據(jù)庫(kù)記錄主數(shù)據(jù)庫(kù)存儲(chǔ)記錄項(xiàng)數(shù)據(jù)安全數(shù)據(jù)庫(kù)存儲(chǔ)用戶賬號(hào)、密碼、權(quán)限信息系統(tǒng)數(shù)據(jù)庫(kù)存儲(chǔ)系統(tǒng)數(shù)據(jù)4歷史記錄數(shù)據(jù)庫(kù)存儲(chǔ)軟件使用的歷史情況5、運(yùn)行需求5.1用戶界面簡(jiǎn)潔明快、造型新穎、有用戶設(shè)置功能5.2硬件接口I/O設(shè)備：顯示器、打印機(jī)、鼠標(biāo)、鍵盤5.3故障處理顯示故障信息，有一定自動(dòng)糾錯(cuò)功能6、安全需求應(yīng)提供基本的安全控制，包括：賬戶密碼控制、用戶權(quán)限控制、跟蹤審計(jì)控制文檔號(hào)IM00102概要設(shè)計(jì)說(shuō)明書(shū)1、引言：1.1編寫目的概要設(shè)計(jì)是為了說(shuō)明系統(tǒng)的功能分配，模塊劃分，程序的總體結(jié)構(gòu)，輸入輸出及接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為詳細(xì)設(shè)計(jì)奠定基礎(chǔ)。1.2項(xiàng)目背景該項(xiàng)目由信息管理系九八級(jí)學(xué)生蔡文亮同學(xué)單獨(dú)開(kāi)發(fā)，擬在作為軟件分發(fā)出去。1.3定義本說(shuō)明書(shū)中業(yè)務(wù)流程圖（TFD）采用薛華成的《管理信息系統(tǒng)（第三版）》p.339標(biāo)準(zhǔn)。1.4參考資料薛華成管理信息系統(tǒng)（第三版）清華大學(xué)出版社1999.5需求規(guī)格說(shuō)明書(shū)文檔號(hào)IM00101鄭人杰、殷人昆、陶永雷《實(shí)用軟件工程（第二版）》清華大學(xué)出版社，1997.42、任務(wù)概述2.1目標(biāo)：作為一個(gè)簡(jiǎn)便易用的自由軟件2.2運(yùn)行環(huán)境：WINDOWS95/98/ME/NT/2000Paradox數(shù)據(jù)庫(kù)管理系統(tǒng)硬件環(huán)境：1BM-PC機(jī)，筆記本電腦2.3開(kāi)發(fā)方案：利用BorlandC++Builder5.0單獨(dú)完成試用版的開(kāi)發(fā)工作。3、總體設(shè)計(jì)3.1處理流程（如圖1）另：系統(tǒng)啟動(dòng)時(shí)有登錄過(guò)程，登錄成功后有系統(tǒng)的配置過(guò)程。3.2總體結(jié)構(gòu)和模塊外部設(shè)計(jì)為方便閱讀，現(xiàn)將軟件的總體結(jié)構(gòu)圖示如下：（如圖2）尤其擬用RAD（RapidApplicationDevelopment）BCB進(jìn)行開(kāi)發(fā)，故各模塊之間功能相對(duì)獨(dú)立，各模塊共用的數(shù)據(jù)有記錄數(shù)據(jù)庫(kù)、安全數(shù)據(jù)庫(kù)和系統(tǒng)數(shù)據(jù)。4、接口設(shè)計(jì)4.1外部接口用戶界面：用戶界面要求較活潑，符合小軟件的風(fēng)格。軟件接口：無(wú)硬件接口：無(wú)特殊硬件接口，用戶采用鍵盤、顯示器、鼠標(biāo)作為主要設(shè)備，查詢結(jié)果也可用打印機(jī)輸出。4.2內(nèi)部接口各模塊之間并無(wú)直接的通信關(guān)系，通過(guò)系統(tǒng)數(shù)據(jù)來(lái)傳遞信息。5、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)本系統(tǒng)中自行定義的數(shù)據(jù)結(jié)構(gòu)是系統(tǒng)數(shù)據(jù)作用是描述系統(tǒng)設(shè)置，其邏輯結(jié)構(gòu)和含義如下：（用類C語(yǔ)言描述）ClassSystemData{〃系統(tǒng)數(shù)據(jù)定義boolColorFlag；〃是否用缺省的配置T不用F用longSColor；〃用戶有定義色彩boolPictureFlag；〃是否使用背景圖案T是F否charSPicture[100]；〃背景圖案位置boolAlarm；//提醒功能開(kāi)關(guān)T開(kāi)F關(guān)boolRecord；〃跟蹤審計(jì)功能開(kāi)關(guān)T開(kāi)F關(guān)boolGrant[4][4]；//權(quán)限矩陣T有權(quán)限F無(wú)權(quán)限};該數(shù)據(jù)結(jié)構(gòu)的物理設(shè)計(jì)從略該數(shù)據(jù)結(jié)構(gòu)記錄系統(tǒng)設(shè)置系統(tǒng)啟動(dòng)時(shí)使用，系統(tǒng)設(shè)置以及安全設(shè)置模塊對(duì)其修改6、運(yùn)行設(shè)計(jì)6.1運(yùn)行模塊的組合該系統(tǒng)采用事件驅(qū)動(dòng)思想，要求各模塊間事件執(zhí)行，嚴(yán)格并執(zhí)行系統(tǒng)及兩個(gè)以上的模塊。6.2運(yùn)行控制各模塊的運(yùn)行采用事件驅(qū)動(dòng)的方式，在WINDOWS主控窗體（本系統(tǒng)中稱之為控制面板）的控制下，由事件驅(qū)動(dòng)運(yùn)行。7、出錯(cuò)處理本系統(tǒng)中，出錯(cuò)主要是由于數(shù)據(jù)庫(kù)操作失誤引起軟件運(yùn)行出錯(cuò)，其它出錯(cuò)可能不大，故出錯(cuò)處理只是簡(jiǎn)單的WINDOWS風(fēng)格的告知窗口，并由系統(tǒng)處理出錯(cuò)情況。8、安全保密設(shè)計(jì)在軟件的一級(jí)采用帳號(hào)密碼、權(quán)限控制、審計(jì)跟蹤（可選）三種方式進(jìn)行安全保密。文檔號(hào)IM00103詳細(xì)設(shè)計(jì)說(shuō)明書(shū)1、引言1.1編寫目的：在概要設(shè)計(jì)的條件下，繼續(xù)工作，為編碼人員提供編碼依據(jù)，同時(shí)也會(huì)測(cè)試維護(hù)人員提供依據(jù)。1.2項(xiàng)目背景作為自由軟件的一個(gè)項(xiàng)目。1.3定義本文檔格式按參考資料①P.4831.4參考資料鄭人杰、殷人昆、陶永雷《實(shí)用軟件工程（第二版）》清華大學(xué)出版社1997.4需求規(guī)格文檔說(shuō)明書(shū)文檔號(hào)IM00101詳細(xì)設(shè)計(jì)說(shuō)明書(shū)文檔號(hào)IM001022、總體設(shè)計(jì)2.1要求概述2.2軟件結(jié)構(gòu)3、程序描述3.1錄入修改功能模塊3.1.1功能：對(duì)記錄數(shù)據(jù)庫(kù)進(jìn)行插入和修改操作3.1.2性能：要求對(duì)響應(yīng)：響應(yīng)時(shí)間不超過(guò)1秒3.1.3輸入項(xiàng)目：①原始數(shù)據(jù)修改信息3.1.4輸出項(xiàng)目：①完成信息②出錯(cuò)信息3.1.5并法無(wú)特殊并法3.1.6程序邏輯3.1.7接口：用戶界面設(shè)計(jì)3.1.8測(cè)試要點(diǎn)：①對(duì)輸出信息是否及時(shí)輸出，輸出內(nèi)容是否正確的測(cè)試②對(duì)輸入信息的完整性約束條件的測(cè)試3.2查詢模塊3.2.1功能：根據(jù)用戶給出條件查詢記錄Drs中的信息，顯示查詢結(jié)果，并可打印查詢結(jié)果3.2.2性能：①查詢過(guò)程不超過(guò)2秒鐘，盡量縮短查詢時(shí)間②給出適當(dāng)?shù)某鲥e(cuò)控制3.2.3輸入項(xiàng)目查詢條件②查詢系統(tǒng)3.2.4輸出項(xiàng)目查詢結(jié)果、報(bào)表3.2.5并法無(wú)特殊并法3.2.6程序邏輯3.2.7接口界面設(shè)計(jì)3.2.8測(cè)試要點(diǎn)①SQL語(yǔ)句生成機(jī)構(gòu)的健壯性，是否會(huì)產(chǎn)生不可執(zhí)行的SELECT語(yǔ)句，引起查詢失敗，系統(tǒng)出錯(cuò)。報(bào)表生成機(jī)構(gòu)是否會(huì)顯示查詢的手段。3.3安全設(shè)置模塊3.3.1功能：登錄帳號(hào)和密碼程序帳戶權(quán)限的范圍控制控制是否隱蔽部分內(nèi)容注:本功能模塊只允許admin帳號(hào)以及admin授權(quán)帳號(hào)管理I、帳號(hào)密碼：每用戶均需一注冊(cè)的帳號(hào)及相應(yīng)密碼進(jìn)行登錄，系統(tǒng)有管理員帳號(hào)admin，初始密碼是123456。II、權(quán)限控制，設(shè)有0?4級(jí)權(quán)限。權(quán)限的控制程度為功能模塊，用戶可根據(jù)實(shí)際情況設(shè)定權(quán)限的實(shí)際權(quán)限。III、跟蹤審計(jì)，可選功能，功能為記錄用戶登錄情況和操作情況。3.3.