軟件項目文檔需求文檔書寫規(guī)范

1、.軟件項目計劃概要1引言 11 總綱 概述項目開發(fā)因由以及背景和前提條件情況，簡介對大環(huán)境的利好，以及為社會公司 團隊所能帶來的收益。12 項目規(guī)劃項目名稱, ,軟硬件配置要求 ,編寫環(huán)境，計劃開發(fā)工期，實施及驗收完成工期 其中包括本項目計劃投入團隊人次，計劃研發(fā)完成時間,計劃上線及驗收完成時間。界定延伸拓展范圍，界定后續(xù)服務范圍。界定項目是否分級完成，界定項目是否分級部署運行。 項目計劃投入費用，項目計劃盈余費用等。13 專業(yè)用語 列出本項目中所需專業(yè)術(shù)語配以英文縮寫詞及原文(如無則不強調(diào)！)。 14 團隊配置要求 團隊人員配置：項目經(jīng)理,系統(tǒng)架構(gòu)工程師、系統(tǒng)需求工程師、軟件開發(fā)人員、軟件測

2、試人員,項目實施人員等； 團隊人員關系配置：團隊人員所屬配置，人員協(xié)作關系配置，團隊軟硬件環(huán)境配置。2項目概述 21 待開發(fā)軟件的一般描述 描述軟件服務對象以及目標要求，描述軟件大環(huán)境前景，描述軟件應用服務范圍。 22 待開發(fā)軟件功能簡述 簡述待開發(fā)軟件所具備的功能。建議以圖表配以文字。流程圖配以文字的形式展示和描述。 既定功能模塊圖表； 系統(tǒng)功能流程走勢； 延伸拓展功能概念走勢； 軟件效用圖表。 23 運行環(huán)境 描述軟件的運行環(huán)境，包括硬件平臺、硬件要求、操作系統(tǒng)版本，以及其他的軟 件或與其共存的應用程序等。 24 條件與限定 研發(fā)時長限定 編寫工具限定； 軟硬件限定； 開發(fā)規(guī)范與標準限定。

3、 3軟件功用及目標 31 功能劃分 列舉出所開發(fā)的軟件能實現(xiàn)的全部功能，可采用文字、圖表或數(shù)學公式等多種方法 進行描述。 32 功能描述 對各個功能進行詳細的描述。 4外部接口需求 41 用戶界面 描述用戶希望該軟件所具有的界面特征，其中包括。 屏幕布局； 菜單布局； 輸入輸出格式； 錯誤信息顯示格式； 42 硬件接口 描述系統(tǒng)中軟件產(chǎn)品和硬件設備每一接口的特征，以及硬件接口支持的設備、軟件與硬件接口之間，以及硬件接口與支持設備之間的約定，包括交流的數(shù)據(jù)和控制信息的性質(zhì)以及所使用的通信協(xié)議。 43 軟件接口 描述該軟件產(chǎn)品與其有關軟件的接口關系，并指出這些外部軟件或組件的名字和版本號。比如運行

4、在什么操作系統(tǒng)上，訪問何種類型的數(shù)據(jù)庫，使用什么數(shù)據(jù)庫連接組件，和什么商業(yè)軟件共享數(shù)據(jù)等。 44 通信接口 描述和本軟件產(chǎn)品相關的各種通信需求，包括電子郵件、Web瀏覽器、網(wǎng)絡通信協(xié)議等。 45 故障處理 對可能的軟件、硬件故障以及對各項性能而言所產(chǎn)生的后果進行處理。 5性能需求 51 數(shù)據(jù)精確度 輸出結(jié)果精度。 52 時間特性 時間特性可包括如下幾方面 響應時間； 更新處理時間； 數(shù)據(jù)轉(zhuǎn)換與傳輸時間； 運行時間等。 53 適應性 在操作方式、運行環(huán)境、與其他軟件的接口以及開發(fā)計劃等發(fā)生變化時，軟件的適應能力。 6其他需求 列出在本文的其他部分未出現(xiàn)的需求。如果不需要增加其他需求，可省略這一部分。 7數(shù)據(jù)描述 71 靜態(tài)數(shù)據(jù) 72 動態(tài)數(shù)據(jù) 包括輸入數(shù)據(jù)和輸出數(shù)據(jù)。 73 數(shù)據(jù)庫描述 給出使用數(shù)據(jù)庫的名稱和類型。 74 數(shù)據(jù)字典 對于數(shù)據(jù)流圖、層次方框圖中出現(xiàn)的所有圖形元素在數(shù)據(jù)字典中都要作為一個詞條加以定義，使得每一個圖形元素都有唯一的一個清晰明確的解釋。 數(shù)據(jù)字典中所有的定義必須是嚴密的、精確的，不可有二意性。 75 數(shù)據(jù)采集