文檔編寫規(guī)范：標(biāo)準(zhǔn)化與代碼規(guī)范

文檔編寫規(guī)范：標(biāo)準(zhǔn)化與代碼規(guī)范

軍無疑問，文檔是項(xiàng)目管理中最關(guān)鍵的部分之一，文檔的規(guī)范與否關(guān)系到項(xiàng)目進(jìn)展?fàn)顩r，關(guān)系整個(gè)項(xiàng)

目工作的效率與效益。

往往越是規(guī)模大的公司，其項(xiàng)目工作中的每?個(gè)環(huán)節(jié)都有相應(yīng)的規(guī)范進(jìn)行管理，這些規(guī)范都

是都前輩嘔心瀝血，披荊斬棘所獲的的經(jīng)驗(yàn)總結(jié)，而非普通文書工作者的推猜可得。

當(dāng)然，如果剛剛創(chuàng)業(yè)起步的小公司如能更早的抓住項(xiàng)目規(guī)范、文檔規(guī)范，更是使公司發(fā)展或

者比大公司更大的推動力。

做文檔應(yīng)當(dāng)十分注意細(xì)節(jié)問題，可以文檔的細(xì)節(jié)規(guī)范決定文檔的成敗，正所謂細(xì)節(jié)決定成敗。

1.首先，絕對不允許有錯(cuò)別字。

2.文檔標(biāo)題:命名標(biāo)準(zhǔn)為:客戶公司名稱+項(xiàng)目名稱+版本號JXX公司采編項(xiàng)目_VLO）。

3.文檔屬性：打開word文檔一》文件一＞屬性（標(biāo)題、作者、單位）。

4.首頁：文檔標(biāo)題，客戶公司和實(shí)施公司LOGO,左下角標(biāo)注（實(shí)施公司名，作者，更新

時(shí)間,版本.文檔編號）.

5.文檔管理：修改記錄，審閱記錄，分發(fā)記錄，致被分發(fā)者。

6.目錄：動態(tài)更新目錄，任何欄目修改都要及時(shí)更新。

7.項(xiàng)目編號：整個(gè)項(xiàng)目編號撐起了整篇文檔的欄目構(gòu)架，在視圖一＞文檔構(gòu)架圖中應(yīng)可以

看清這個(gè)脈絡(luò)。

8.文檔字體：文檔的項(xiàng)目編號、正文、注釋都應(yīng)有相應(yīng)的字體大小。

9.圖片表格：每個(gè)圖片和表格都必須要編號。

10.段落：段落的之間的行距，是否空行，緊密程度應(yīng)當(dāng)十分注意，影響整體美觀，

11.頁眉和頁腳：頁眉，左邊是實(shí)施公司LOGO,右邊是文檔標(biāo)題；頁腳，左邊有公司名及

版權(quán)聲明。

擁有準(zhǔn)確技術(shù)文檔不僅對于公司是非常有益處，而且也能夠讓客戶從中受益。由于產(chǎn)品如何使用在某種

程度上是要依賴技術(shù)文檔來進(jìn)行說明，因此技術(shù)文檔必須十分準(zhǔn)面可靠。使用不準(zhǔn)確和已經(jīng)過時(shí)技術(shù)文檔

對于公司發(fā)展也會產(chǎn)生一定阻礙，同樣，它也會對公司客戶們產(chǎn)生消極影響。一旦客戶發(fā)現(xiàn)在他們使用產(chǎn)

品時(shí)候遇到了問題，卻不能通過求助于伴隨產(chǎn)品技術(shù)文檔手段進(jìn)行解決時(shí)候，客戶們就會對這種產(chǎn)品產(chǎn)生

懷疑乃至于失去信心，那么，公司信譽(yù)和利益自然而然就會受到損害。這就是不準(zhǔn)確和過時(shí)技術(shù)文檔給我

們帶來危害。

缺乏準(zhǔn)確性以及內(nèi)容晌澀難懂都會讓開發(fā)新手以及其他一些技術(shù)工作者們對這些技術(shù)文檔敬而運(yùn)之，

從而不利丁?他們學(xué)習(xí)和掌握。在本篇文章中，我們要討論就是如何在你開發(fā)小組中編寫出準(zhǔn)確而且易于掌

握技術(shù)文檔。

技巧一：制定出一個(gè)技術(shù)評價(jià)核對表

許多程序開發(fā)設(shè)計(jì)者以及管理者都缺乏從技術(shù)上評價(jià)一個(gè)文檔經(jīng)驗(yàn)。這里有一些方法可以提高這些技

術(shù)文檔準(zhǔn)確性：

把注意力集中于技術(shù)事實(shí)上，這樣能夠核實(shí)這些技術(shù)是作為技術(shù)文檔而被編寫出來。技術(shù)評論工作并

不等同于一般編輯工作。

一定要從技術(shù)上核實(shí)，在技術(shù)文檔里編寫程序與步驟準(zhǔn)確性,

一定要從技術(shù)上核實(shí)，在技術(shù)文檔中使用圖片捕捉準(zhǔn)確性。

技巧二：一定要在技術(shù)文檔編寫過程中明確責(zé)任

技術(shù)文檔編寫不一個(gè)原因常常是由于對它不夠重視。這是由于在編寫技術(shù)文檔時(shí)候，沒有十分明確各

種責(zé)任。因此，一定要在技術(shù)文檔編寫過程中明確責(zé)任，這些方法包括：

在技術(shù)文檔中加入作者以及相關(guān)人員姓名。一些公司口］?能有規(guī)定，禁止出現(xiàn)員工姓名，但是在技術(shù)文

檔中包含作者以及相關(guān)人士姓名做法能夠促進(jìn)這些內(nèi)部員工之間交流。對于外部文檔使用者，比如為商業(yè)

現(xiàn)貨軟件編寫用戶指南，可以加入作者以及相關(guān)人員姓名，用以明確和承認(rèn)他們對開發(fā)所做工作和貢獻(xiàn)。

把文檔技術(shù)評論作為提供給開發(fā)設(shè)計(jì)人員年度評論一部分。

在項(xiàng)目計(jì)劃中指派專人負(fù)責(zé)技術(shù)評論工作。

技巧三：增加技術(shù)文檔編寫者準(zhǔn)確性

由于技術(shù)文檔編寫者在許多公司內(nèi)都是非常主觀一個(gè)職位，并且編寫技術(shù)文檔也是他們最主要職責(zé)，

因此做這些工作人都必須與他們所編寫技術(shù)文檔準(zhǔn)確性有著直接利害關(guān)系.字串7

管理人員應(yīng)該為技術(shù)文檔編寫者設(shè)置適當(dāng)技術(shù)準(zhǔn)確級別，并要求他們把準(zhǔn)確性保持在這一范圍之內(nèi)。

由于一些技術(shù)文檔編寫者對于提升自己對于技術(shù)理解總是不太枳極主動，因此，增加他們責(zé)任讓他們面對

更多壓力對項(xiàng)目里每一個(gè)人來說都是有處。如果一個(gè)技術(shù)文檔編寫者無法達(dá)到更高標(biāo)準(zhǔn)，那么你就需要重

新審視一下你技術(shù)文檔編寫者是否能夠滿足你們團(tuán)隊(duì)?wèi)?zhàn)略要求，必否能夠滿足客戶們需要呢？

為了幫助技術(shù)文檔編寫者，你需要讓他們對于具體技術(shù)有著更深層次認(rèn)識，因此，作為管理者，你應(yīng)

該：

讓技術(shù)文檔編寫者多參加有關(guān)產(chǎn)品設(shè)計(jì)與開發(fā)小組會議。

讓技術(shù)文檔編寫者參與到技術(shù)要求、功能規(guī)范以及設(shè)計(jì)方案開發(fā)工作中去。

把技術(shù)文檔編寫者包括進(jìn)開發(fā)小組郵件列表中去。

這技術(shù)文檔編寫周期，力巴產(chǎn)品在公司內(nèi)部進(jìn)行發(fā)布。技術(shù)文檔編寫者很容易變得非常封閉，但是如果

把產(chǎn)品在內(nèi)部首先發(fā)布一下，那么就能夠給開發(fā)人員以及項(xiàng)目管理人員提供一種新途徑來了解以前可能并

不容易了解情況。

鼓勵(lì)技術(shù)文檔編寫者更多了解有關(guān)產(chǎn)品背后所包含各種技術(shù),舉個(gè)例子來說，如果你開發(fā)基于Java語

言應(yīng)用軟件，那么，就應(yīng)該鼓勵(lì)技術(shù)文檔編寫者多多了解Java編程語言，并且盡量讓他們能夠流暢掌握這

門編程語言。

技巧四：設(shè)置任務(wù)優(yōu)先次序

通常情況下，主要開發(fā)設(shè)計(jì)人員腦海中包含著有關(guān)整個(gè)項(xiàng)1=1信息，而且，有時(shí)候還會同時(shí)考慮滬多其

它項(xiàng)目。即使他或者她日程安排已經(jīng)非常緊張，但是，他們腦海中產(chǎn)品信息對于確保技術(shù)文檔編寫出確性

來說是非常重要。

當(dāng)前形勢讓我們不得不以更少資源完成更多任務(wù)，而作為開發(fā)設(shè)計(jì)人員，由于他們工作特殊性，這些

人總是處于緊張而繁忙狀態(tài)下。下面是一些技巧，可以幫助你從這些忙碌開發(fā)設(shè)計(jì)人員哪里獲得你所需要

信息，并且保證能讓他們知識給技術(shù)文檔編寫帶來處：

不要讓他們從頭至尾審閱技術(shù)文檔。

和技術(shù)文檔編寫者一起確定哪些部分必須讓開發(fā)設(shè)計(jì)人員進(jìn)行審閱。

與他們一起利用大段完整時(shí)間來審閱技術(shù)文檔。

如果技術(shù)文檔審闞者時(shí)間表安排得很緊,那么就給他提供一個(gè)具體列表，在其中明確哪些部分你需要

他進(jìn)行審閱。并且保證讓小組內(nèi)其他成員完成剩余部分審閱工作：技術(shù)文檔中與審閱者專業(yè)技術(shù)領(lǐng)域直接

相關(guān)部分絕對是需要他進(jìn)行仔細(xì)審閱。

更完成審閱工作

充分有效完成技術(shù)文檔審閱工作不僅會讓外部用戶，也會讓內(nèi)部用戶從中受益。但是，經(jīng)常會有技術(shù)

人員認(rèn)為做這樣工作是沒有多大意義，那么，作為管理者就面對著這樣一-種挑戰(zhàn)，就是要在整個(gè)審閱過程

中設(shè)置優(yōu)先次序從而保證為開發(fā)工作所做出努力獲得成功。

軟件測試文檔的流程

整個(gè)測試過程的文檔。

先寫測試策略，測試策略包括：所要測試的范圍，階段的劃分，已經(jīng)每個(gè)階段完成的標(biāo)準(zhǔn)：

然后是書寫測試計(jì)劃，測試計(jì)劃主要包括：誰來做，在哪里做，什么時(shí)間做，為什么做，和做什么：

接著書寫測試方案，如果比較簡單的就不需要書寫測試方案，直接在測試計(jì)劃里就可以寫明白，比較復(fù)雜

的才寫測試方案，測試方案是書寫專項(xiàng)測試計(jì)劃的，以保證專項(xiàng)測試完成；

再寫測試用例，也就是說該怎么做；

測試執(zhí)行后生成測試記錄和缺陷報(bào)告：

測試結(jié)束后，生成測試報(bào)告。

文檔資料規(guī)范要求

一、資料格式要求

1、紙型

所有紙質(zhì)文字資料除個(gè)別表格必須使用A3紙以外，其余一律用A4復(fù)印紙。

2、封面

文件必須按《國家行政機(jī)關(guān)公文格式》執(zhí)行。紙質(zhì)材料一般不加封面，確需加封面的材料可以加上，如規(guī)

章制度、材料匯編等。封面可使用必要的文字和徽標(biāo)，但不宜使用花邊和其它圖案。加封面的材料同時(shí)應(yīng)

加封底。

3、文檔

（1）頁面設(shè)置:

四、復(fù)印

上下左右居中對齊，如無特殊需要，版面圖文的顏色均為黑色，盡量雙頁印刷，做到均勻清晰，杜絕漏印、

倒印等錯(cuò)誤現(xiàn)象。重要材料的復(fù)印件必須注明“與原件相符”字樣，并加蓋公章（紅色）。

五、裝訂

一律用夾子夾在左側(cè)，不需裝訂。在首頁的左上角用鉛筆注明資料卷號，如：3-2-17

六、注意事項(xiàng)

學(xué)年和年度的區(qū)別，區(qū)劃調(diào)整前后名稱的區(qū)別，及時(shí)間的界定

文檔

1.保持文檔整潔，書寫工整，使用黑筆填寫。

2.使用訂數(shù)訂裝訂文檔左上角。

3.文檔要分類擺放，sitelog和sitefolder分開。

游戲軟件文檔編寫規(guī)范

文檔編寫標(biāo)準(zhǔn)化：在游戲開發(fā)之先，實(shí)際上，美術(shù)，程序，游戲設(shè)計(jì)各部門及各部門之后，就已經(jīng)

有這個(gè)了，如游戲文件的命名，部門文檔或文件的命名，還有一些文檔或是表中，或是腳本中的說明書，

都是此類-

可行性分析報(bào)告：這個(gè)就是立項(xiàng)報(bào)告，游戲軟件的可行性分析，一些要對比分析市場同類產(chǎn)品，風(fēng)險(xiǎn)

評估等等，在它的規(guī)范之外的東西。一般由主設(shè)計(jì)師及項(xiàng)目負(fù)責(zé)人來寫一些與程序相關(guān)，與美術(shù)相關(guān)

項(xiàng)目開發(fā)計(jì)劃：這個(gè)面向的用戶是團(tuán)隊(duì)及投資人，要非常清楚的寫明各部門在各階段計(jì)劃完成

什么。由項(xiàng)目負(fù)責(zé)人及各部門負(fù)責(zé)來寫這個(gè)。

軟件需求說明書：這個(gè)是由游戲設(shè)計(jì)部門與程序部門一起完成（但大部分公司游戲設(shè)計(jì)部門達(dá)不到

這個(gè)水平），也就是游戲的數(shù)據(jù)結(jié)構(gòu)啊，數(shù)據(jù)庫列啊，等等東西。

概耍設(shè)計(jì)說明書：這個(gè)就是游戲的總案，用來指導(dǎo)團(tuán)隊(duì)開發(fā)的總方向，如果有變動，優(yōu)先會改這個(gè),

就是一個(gè)游戲開發(fā)過程中的路燈，是由主設(shè)計(jì)師來寫這個(gè)的。

詳細(xì)設(shè)計(jì)說明書：這個(gè)在游戲開發(fā)過程中，山N個(gè)文檔共同構(gòu)成，但大概規(guī)范不必拘泥，視寫的文

檔的類型可自行調(diào)整。這是各部門都是如此，都有自己的規(guī)范。寫這個(gè)，一般就走游戲設(shè)計(jì)師

用戶操作手冊：這個(gè)對應(yīng)游戲開發(fā)，分兩部分：

對內(nèi)，在各目錄中，各文檔都應(yīng)該有比較清楚的標(biāo)釋或走說明，作用在于如果新同事或處有人接你

的工作，至少他應(yīng)該可以知道怎么繼續(xù)，程序部門對應(yīng)的程序文件的注釋。

對外，就是給玩家說明書，官方網(wǎng)站的一些內(nèi)容，也在此例。

上面的工作，是由游戲設(shè)計(jì)部門完成（對內(nèi)的，只對本部門）

測試計(jì)劃：這個(gè)是由主設(shè)計(jì)師來做的，就是在內(nèi)部內(nèi)測時(shí),主要測什么，有多少人來做，如何測法,

測試的目的要明確

測試的目的，如同場景用戶壓力測試，門派平衡測試，模擬升級測試。

PS：題外一下，如果你們的主程夠強(qiáng)，一部分的測試可以虛擬機(jī)器完成，曾經(jīng)的某項(xiàng)目中，在中期

門派平衡涮試和模擬升級測試，設(shè)計(jì)部門在沒有軟件的情況下，用excel都已經(jīng)做的達(dá)到目的了

測試分析報(bào)告：由各部門主管完成，要總結(jié)測試的結(jié)果，要修改的地方，如果修改等等，然后安

排活大家分頭去修改自己負(fù)責(zé)的地方

項(xiàng)目開發(fā)總結(jié)報(bào)告：這個(gè)，別的公司我不知道，但我每當(dāng)一階段都會自己做個(gè)總結(jié)的，如果老比較

正規(guī)的公司會要求部門管理人員寫這個(gè)的

軟件維護(hù)手冊：這個(gè)是交GV部門的，是由游戲i殳計(jì)部門來寫的.對應(yīng)網(wǎng)絡(luò)游戲是這樣的.包括

的工具的設(shè)計(jì)，GM的培訓(xùn)計(jì)劃等等

軟件問題報(bào)告：這個(gè)就走對應(yīng)網(wǎng)絡(luò)游戲軟件，就是玩家反饋BUG或是一些意見的處理行為的文檔，

由游戲設(shè)計(jì)部負(fù)責(zé)來完成，執(zhí)行人為設(shè)計(jì)部與GM部門

軟件修改報(bào)告：這個(gè)不是很需要報(bào)告的，但需要游戲設(shè)計(jì)部負(fù)責(zé)來安排這個(gè)工作，不管是哪的問題

進(jìn)行分流處理。

2007年11月26日星期一10:53A、三種編寫方法

1、用好的結(jié)構(gòu)化和自然語言編寫文本型文檔；

2、建立圖形化模型，這些模型可以描繪轉(zhuǎn)換過程、系統(tǒng)狀態(tài)、和它們之間的變化、數(shù)據(jù)關(guān)系、邏輯

流或?qū)ο箢惡退麄兊年P(guān)系：

3、編寫形式化規(guī)格說明，這可以通過使用數(shù)學(xué)上精確的形式化邏輯語言來定義需求。

多種編寫方法可在同一個(gè)文檔使用，根據(jù)需要選擇，或互為補(bǔ)充，以能夠把需求說明白為目的。

B、應(yīng)有■成果

1、各業(yè)務(wù)手，辦埋流程文字說明；

2、各業(yè)務(wù)手工辦理流程圖；

3、各業(yè)務(wù)手工辦理各環(huán)節(jié)輸入輸出表單、數(shù)據(jù)來源：

4、目標(biāo)軟件系統(tǒng)功能劃分（示意圖及文字說明）：

5、目標(biāo)軟件系統(tǒng)中各業(yè)務(wù)辦理流程文字說明：

6、目標(biāo)軟件系統(tǒng)中各業(yè)務(wù)辦理流程圖（模型）；

7、目標(biāo)軟件系統(tǒng)中各業(yè)務(wù)辦理各環(huán)節(jié)數(shù)據(jù)、數(shù)據(jù)采集方式、數(shù)據(jù)間的內(nèi)在聯(lián)系分析。

8、目標(biāo)軟件系統(tǒng)用戶界面圖、各式系統(tǒng)邏輯模型圖及說明

C、文檔工具推薦

1、調(diào)研結(jié)果《需求分析說明書》格式參照開發(fā)文檔模板；

2、單位組織結(jié)構(gòu)圖、功能模塊分解圖用VISIO繪制，或直接用WORD中的畫圖工具；

3、業(yè)務(wù)流程圖用VIS10中的FLOWCHART模板繪制;

4、系統(tǒng)邏輯模型使用ROSE繪制活用VISIO中的UML模板繪制：

5、軟件用戶界面用V：SIO中的WIN95USERINTERFACE模板繪制：

6、數(shù)據(jù)物理模型用POWERDESINER繪制；

D、需求文檔編寫原則

1、句子簡短完整，具有正確的語法、拼寫和標(biāo)點(diǎn)：

2、使用的術(shù)語與詞匯表中所定義的一致：

3、需求陳述應(yīng)該有一致的樣式，例如“系統(tǒng)必須”或者“用戶必須，并緊跟一個(gè)行為動作

和可觀察的結(jié)果。：

4、避免使用模糊、主觀的術(shù)語，減少不確定性，如“界面友好、操作方便”；

5、避免使用比較性詞語，如“提高”，應(yīng)定量說明提高程度

軟件工程文檔編寫標(biāo)準(zhǔn)

在項(xiàng)目開發(fā)過程中，應(yīng)該按要求編寫好十三種文檔，文檔編制要求具有針對性、精確性、清晰性、完整性、

靈活性、可追硼性。

O可行性分析報(bào)告：說明該軟件開發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會因素上的可行性，評述為了

合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實(shí)施方案，說明并論證所選定實(shí)施方案的理由。

O項(xiàng)目開發(fā)計(jì)劃：為軟件項(xiàng)目實(shí)施方案制訂出具體計(jì)劃，應(yīng)該包括各部分工作的負(fù)責(zé)人員、開發(fā)的進(jìn)

度、開發(fā)經(jīng)費(fèi)的預(yù)算、所需的硬件及軟件資源等。

?軟件需求說明書（軟件規(guī)格說明書）：對所開發(fā)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出

詳細(xì)的說明。它是在用戶與開發(fā)人員雙方對軟件需求取得共同理解并達(dá)成協(xié)議的條件下編寫的，也是實(shí)施

開發(fā)工作的基礎(chǔ)。該說明書應(yīng)洽出數(shù)據(jù)邏輯和數(shù)據(jù)采集的各項(xiàng)要求，為生成和維護(hù)系統(tǒng)數(shù)據(jù)文件做好準(zhǔn)備。

O概要設(shè)計(jì)說明書：該說明書是概要實(shí)際階段的工作成果，它應(yīng)說明功能分配、模塊劃分、程序的總

體結(jié)構(gòu)、輸入輸出以及接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為詳細(xì)設(shè)計(jì)提供基砧。

O詳細(xì)設(shè)計(jì)說明書：著直描述每一模塊是怎樣實(shí)現(xiàn)的，包括實(shí)現(xiàn)算法、邏輯流程等。

O用戶操作手冊：本手冊詳細(xì)描述軟件的功能、性能和用戶界面，使用戶對如何使用該軟件得到具體

的了解,為操作人員提供該軟件各種運(yùn)行情況的有關(guān)知識，特別是操作方法的具體細(xì)節(jié)。

O測試計(jì)劃：為做好集成測試和驗(yàn)收測試，需為如何組織測試制訂實(shí)施計(jì)劃。計(jì)劃應(yīng)包括測試的內(nèi)容、

進(jìn)度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范國等。

O測試分析報(bào)告：測試工作完成以后，應(yīng)提交測試計(jì)劃執(zhí)行情況的說明，對測試結(jié)果加以分析，并提

出測試的結(jié)論意見。

O開發(fā)進(jìn)度月報(bào)：該月報(bào)系軟件人員按月向管理部門提交的項(xiàng)目進(jìn)展情況報(bào)告，報(bào)告應(yīng)包括進(jìn)度計(jì)劃

與實(shí)際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個(gè)月的打算等。

o項(xiàng)目開發(fā)總結(jié)報(bào)告：軟件項(xiàng)目開發(fā)完成以后，應(yīng)與項(xiàng)目實(shí)施計(jì)劃對照，總結(jié)實(shí)際執(zhí)行的情況，如進(jìn)

度、成果、資源利用、成本和投入的人力，此外，還需對開發(fā)工作做出評價(jià)，總結(jié)出經(jīng)驗(yàn)和教訓(xùn)。

?軟件維護(hù)手冊：主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件的說明、維護(hù)過程的

說明，便于軟件的維護(hù)。

O軟件問題報(bào)告：指出軟件問題的登記情況，如日期、發(fā)現(xiàn)人、狀態(tài)、問題所屈模塊等，為軟件修改

提供準(zhǔn)備文檔。

o軟件修改報(bào)告：軟件產(chǎn)品投入運(yùn)行以后，發(fā)現(xiàn)了需對其進(jìn)行修正、更改等問題，應(yīng)將存在的詞題、

修改的考慮以及修改的影響作出詳細(xì)的描述，提交審批。

項(xiàng)FI開發(fā)計(jì)劃

1引言

1.1編寫目的：闡明編寫可行性研究報(bào)告的目的，提出讀者對象

1.2項(xiàng)目背景：應(yīng)包括

?項(xiàng)目的委托單位、開發(fā)單位和主管部門：

?該軟件系統(tǒng)與其他系統(tǒng)的美系。

1.3定義：列出文檔中用到的專門術(shù)語的定義和縮寫詞的原文

1.4參考資料：可包括：

?項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或卜.級機(jī)關(guān)的批文

?文檔所引用的資料、規(guī)范等

?列出這些資料的作者、標(biāo)題、編號、發(fā)表FI期、出版單位或資料來源；

2項(xiàng)目概述

2.1工作內(nèi)容:簡要說明項(xiàng)目的各項(xiàng)主要工作，介紹所開發(fā)軟件的功能、性能等：若不編寫可行性研究報(bào)告；

則應(yīng)在本節(jié)給出較詳細(xì)的介紹：

2.2條件與限制：闡明為完成項(xiàng)目應(yīng)具備的條件、開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件。必要時(shí)還

應(yīng)說明用戶及分合同承擔(dān)的工作、完成期限及其他條件與限制。

2.3產(chǎn)品

2.3.1程序：列出應(yīng)交付的程序名稱、使用的語言及存儲形式。

2.3.2文檔：列出應(yīng)交付的文檔。

2.4運(yùn)行環(huán)境：應(yīng)包括硬件環(huán)境、軟件環(huán)境。

2.5服務(wù)：闡明開發(fā)單位可向用戶提供的服務(wù)。如人員培訓(xùn)、安愛、保修、維護(hù)和其他運(yùn)行支持。

2.6驗(yàn)收標(biāo)準(zhǔn)

3實(shí)施計(jì)劃

3.1任務(wù)分解.：任務(wù)的劃分及各項(xiàng)任務(wù)的負(fù)責(zé)人。

3.2進(jìn)度：按階段完成的項(xiàng)目，用圖表說明開始時(shí)間、完成時(shí)間＜

3.3預(yù)算

3.4關(guān)健問題：說明可能影響項(xiàng)目的關(guān)鍵問題，如設(shè)備條件、技術(shù)難點(diǎn)或其他風(fēng)險(xiǎn)因素，并說明對策。

4人員組織及分工

5交付期限

6專題計(jì)劃要點(diǎn)

如測試計(jì)劃、質(zhì)量保證計(jì)劃、配置管理計(jì)戈小人員培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等。

軟件需求說明書

1引言

1.1編寫目的：闡明編寫需求說明書的目的，指明讀者對象。

1.2項(xiàng)目背景：應(yīng)包括

?項(xiàng)目的委托單位、開心單位和主管部門；

?該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。

1.3定義：列出文檔中所用到的專門術(shù)語的定義和縮寫詞的愿文,

1.4參考資料：可包括

?項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文

?文檔所引用的資料、規(guī)范等

?列出這些資料的件者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源

2任務(wù)概述

2.1目標(biāo)

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

2.3條件與限制

3數(shù)據(jù)描述

3.1表態(tài)數(shù)據(jù)

3.2動態(tài)數(shù)據(jù)：包括輸入數(shù)據(jù)和輸出數(shù)據(jù)。

3.3數(shù)據(jù)庫描述：給出使用數(shù)據(jù)庫的名稱和類型。

3.4數(shù)據(jù)詞典

3.5數(shù)據(jù)采集

4功能需求

4.1功能劃分

4.2功能描述

5性能需求

5.1數(shù)據(jù)精確度

5.2時(shí)間特性：如響應(yīng)時(shí)間、更新處理時(shí)間、數(shù)據(jù)轉(zhuǎn)換與傳輸時(shí)間、運(yùn)行時(shí)間等。

5.3適應(yīng)性：在操作方式、運(yùn)行環(huán)境、與其他軟件的接口以及開發(fā)計(jì)劃等發(fā)生變化時(shí)，應(yīng)具有的適應(yīng)能力。

6運(yùn)行需求

6.1用戶界面：如屏幕格式、報(bào)表格式、菜單格式、輸入輸出時(shí)間等。

6.2硬件接口

6.3軟件接口

6.4故障處理

7其他需求

如可使用性、安全保密、可維護(hù)性、可移植性等。

概耍設(shè)計(jì)說明書

1引言

1.1寫目的：闡明編寫概要設(shè)計(jì)說明書的目的，指明讀者對象。

1.2項(xiàng)目背景：應(yīng)包括

?項(xiàng)目的委托單位、開發(fā)單位和主管部門

?該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。

1.3定義：列出本文檔中所用到的專門術(shù)語的定義和縮寫詞的愿意。

1.4參考資料：

?列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源

?項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文：項(xiàng)目開發(fā)計(jì)劃：需求規(guī)格說明書：測試計(jì)劃（初

稿）：用戶操作手冊

?文檔所引用的資料、夾用的標(biāo)準(zhǔn)或規(guī)范。

2任務(wù)概述

2.1目標(biāo)

2.2需求概述

2.3條件與限制

3總體設(shè)計(jì)

3.2總體結(jié)構(gòu)和模塊外部設(shè)計(jì)

3.3功能分配：表明各項(xiàng)功能與程序結(jié)構(gòu)的關(guān)系。

4接口設(shè)計(jì)

4.1外部接口：包括用戶界面、軟件接口與硬件接口。

4.2內(nèi)部接口：模塊之間的接口。

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

6邏輯結(jié)構(gòu)設(shè)計(jì)

所有文檔的統(tǒng)一封面格式如下頁所示。

7物理結(jié)構(gòu)設(shè)計(jì)

8數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系

9運(yùn)行設(shè)計(jì)

9.1運(yùn)行模塊的組合

9.2運(yùn)行控制

9.3運(yùn)行時(shí)間

10出錯(cuò)處理設(shè)計(jì)

10.1出錯(cuò)輸出信息

10.2出錯(cuò)處理對策：如設(shè)置后備、性能降級、恢復(fù)及再啟動等。

11安全保密設(shè)計(jì)

12維護(hù)設(shè)計(jì)

說明為方便維護(hù)工作的設(shè)施，如維護(hù)模塊等。

詳細(xì)設(shè)計(jì)說明書

1引言

1.1編寫目的：闡明編寫詳細(xì)設(shè)計(jì)說明書的目的，指明讀者對象.

1.2項(xiàng)目背定：應(yīng)包括項(xiàng)目的來源和主管部門等。

1.3定義：列出本文檔中所用到的專門術(shù)語的定義和縮寫詞的愿意。

1.4參考資料：

?列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源

?項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文：項(xiàng)目開發(fā)計(jì)劃；霜求規(guī)格說明書；概要設(shè)計(jì)說

明書；測試計(jì)劃（初稿）；用戶操作手冊

?文檔所引用的資料、軟件開發(fā)的標(biāo)準(zhǔn)或規(guī)范。

2總體設(shè)計(jì)

2.1需求概述

2.2軟件結(jié)構(gòu)：如給出軟件系統(tǒng)的結(jié)構(gòu)圖。

3程序描述

3.1逐個(gè)模塊給出以下說明：

?功能

?性能

?輸入項(xiàng)目

?輸出項(xiàng)目

3.2算法：模塊所選用的算法.

3.3程序邏輯：詳細(xì)描述模塊實(shí)現(xiàn)的算法，可采用：標(biāo)準(zhǔn)流程圖：PDL語言：N-S圖：判定表等描述算法的

圖表。

3.4接口

?存儲分配

?限制條件

3.5測試要點(diǎn)：給出測試模塊的主要測試要求。

用戶操作手冊

1引言

1.1編寫目的：闡明編寫手冊的目的，指明讀者對象。

1.2項(xiàng)目背景：說明項(xiàng)目的來源、委托單位、開發(fā)單位及和主管部門。

1.3定義：列出手冊中使用的專門術(shù)語的定義和縮寫詞的愿意。

1.4參考資料：

?列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表F1期、出版單位或資料來源

?項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文；項(xiàng)目開發(fā)計(jì)劃：需求規(guī)格說明書：概要設(shè)計(jì)說

明書；詳細(xì)設(shè)計(jì)說明書：測試計(jì)劃

?文檔中所引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。

2軟件概述

2.1目標(biāo)

2.2功能

2.3性能

2.4數(shù)據(jù)精確度：包括輸入、輸出及處理數(shù)據(jù)的精度。

2.5時(shí)間特性：如響應(yīng)時(shí)間、處理時(shí)間、數(shù)據(jù)傳輸時(shí)間等。

2.6靈活性：在操作方式、運(yùn)行環(huán)境需做某些變更時(shí)軟件的適應(yīng)能力。

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

3.1硬件

?列出軟件系統(tǒng)運(yùn)行時(shí)所需的硬件最小配置.，如計(jì)算機(jī)型號、主存容量

?外存儲器、媒體、記錄格式、設(shè)備型號及數(shù)量

?輸入、輸出設(shè)備

?數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號及數(shù)量。

3.2支持軟件

?操作系統(tǒng)名稱及版本號

?語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號

?數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號

?其他必要的支持軟件

4使用說明

4.1安裝和初始化：給出程序的存儲形式、操作命令、反饋信息及其含意、表明安裝完成的測試實(shí)例以及

安裝所需的軟件工具等。

4.2輸入：給出輸入數(shù)據(jù)或參數(shù)的要求。

?數(shù)據(jù)背景：說明數(shù)據(jù)又源、存儲媒體、出現(xiàn)頻度、限制和質(zhì)量管理等。

?數(shù)據(jù)格式:如長度、格式基準(zhǔn)、標(biāo)號、順序、分隔符、詞匯表、省略和重復(fù)、控制。

?輸入舉例。

4.3輸出：給出每項(xiàng)輸出數(shù)據(jù)的說明。

?數(shù)據(jù)背荒：說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。

?數(shù)據(jù)格式：詳細(xì)闡明每?輸出數(shù)據(jù)的格式，如首部、主體和尾部的具體形式。

?舉例

4.4出錯(cuò)和恢復(fù)：給出出錯(cuò)信息及其含意；用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動。

4.5查詢：說明如何操作。

5運(yùn)行說明

5.1運(yùn)行表：列H；每種可能的運(yùn)行情況，說明其運(yùn)行目的。

5.2運(yùn)行步驟：按順序說明每和運(yùn)行的步驟，應(yīng)包括：

5.3運(yùn)行控制

5.4操作信息：運(yùn)行目的、運(yùn)行目的、操作要求、啟動方法、預(yù)計(jì)運(yùn)行時(shí)間、操作命令格式及說明、其他

事項(xiàng)；

5.5輸入/輸出文件：給出建立或更新文件的有關(guān)信息，如：文件的名稱及編號：記錄媒體：存留的目錄：

文件的支配：說明確定保留文件或廢棄文件的準(zhǔn)則，分發(fā)文件的對象，戰(zhàn)勝硬件的優(yōu)先級及保密控制等。

5.6啟動或恢復(fù)過程

6非常規(guī)過程

提供應(yīng)急非常規(guī)操作的必要信息及操作步驟，如出錯(cuò)處理操作、向后備系統(tǒng)切換操作及維護(hù)人員須知

的操作和注意事項(xiàng)。

7操作命令一覽表

按字母順序逐個(gè)列出全部操作命令的格式、功能及參數(shù)說明,

8程序文件（或命令文件）和數(shù)據(jù)文件一覽表

按文件名字母順序或按功能與模塊分類順序逐個(gè)列出文件名稱、標(biāo)識符及說明。

9用戶操作舉例

測試計(jì)劃

1引言

1.1編寫目的：闡明編寫測試計(jì)劃的目的并指明讀者對象。

1.2項(xiàng)目背景：說明項(xiàng)目的來源、委托單位及主管部門。

1.3定義：列出測試計(jì)劃中所用到的專門術(shù)語的定義和縮寫詞的原意。

1.4參考資料：列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表H期、出版單位或資料來源，可包括：項(xiàng)目的計(jì)

劃任務(wù)書、合同或批文；項(xiàng)目開發(fā)計(jì)劃；需求規(guī)格說明書；概要設(shè)計(jì)說明書；詳細(xì)設(shè)計(jì)說明書：用戶操作

手冊：本測試計(jì)劃中引用的其他資料、采用

的軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。

2任務(wù)概述

2.1目標(biāo)

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

2.3需求概述

2.4條件與限制

3計(jì)劃

3.1測試方案：說明測試方法和選取測試用例的原則。

3.2測試項(xiàng)目：列出組裝測試和確認(rèn)測試中每一項(xiàng)測試的內(nèi)容、名稱、目的和進(jìn)度。

3.3測試準(zhǔn)備

3.4測試機(jī)構(gòu)及人員：測試機(jī)構(gòu)名稱、負(fù)責(zé)人和職責(zé)。

4測試項(xiàng)目說明

4.1按順序逐個(gè)對測試項(xiàng)目做出說明

4.1.1測試項(xiàng)目名稱及測試內(nèi)容

4.1.2測試用例

4.1.3輸入：輸入的數(shù)據(jù)和輸入命令。

4.1.4輸出：預(yù)期的輸出數(shù)據(jù)。

4.2步驟及操作

4.3允許偏差：給出實(shí)測結(jié)果與預(yù)期結(jié)果之間允許偏差的范圍。

4.4進(jìn)度

4.5條件：給出項(xiàng)測試對資源的特殊要求，如設(shè)備、軟件、人員等。

4.6測試資料：說明項(xiàng)測試所需的資料。

5評價(jià)

5.1范圍：說明所完成的各項(xiàng)測試說明問題的范圍及其局限性。

5.2準(zhǔn)則：說明評論測試結(jié)果的準(zhǔn)則。

測試分析報(bào)告

1引言

1.1編寫目的：闡明編寫測試分析報(bào)告的目的并指明讀者對象。

1.2項(xiàng)目背景：說明項(xiàng)目的來源、委托單位及主管部門。

1.3定義：列出測試分析報(bào)告中所用到的專門術(shù)語的定義和縮寫詞的原意。

1.4參考資料：列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：項(xiàng)目的計(jì)

劃任務(wù)書、合同或批文；項(xiàng)目開發(fā)計(jì)劃：需求規(guī)格說明書；概要設(shè)計(jì)說明書：詳細(xì)設(shè)計(jì)說明書；用戶操作

手冊：測試計(jì)劃：測試分析報(bào)告所引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或工程規(guī)范。

2測試計(jì)劃招待情況

2.1機(jī)構(gòu)和人員：給出測試機(jī)構(gòu)名稱、負(fù)責(zé)人和參與測試人員名單。

2.2測試結(jié)果：按順序給出每一測試項(xiàng)目的：實(shí)測結(jié)果數(shù)據(jù)：與預(yù)期結(jié)果數(shù)據(jù)的偏差：該項(xiàng)測試表明的事

實(shí)；該項(xiàng)測試發(fā)現(xiàn)的問題。

3軟件需求測試結(jié)論

按順序給出每?項(xiàng)需求測試的結(jié)論。包括：證實(shí)的軟件能力；局限性（即項(xiàng)目需求未得到充分測試的

情況及原因。

4評價(jià)

4.1軟件能力：經(jīng)過測試所表明的軟件能力。

4.2缺陷和限制：說明測試所揭露的軟件缺陷和不足，以及可能給軟件運(yùn)行帶來的影響。

4.3建議：提出為彌補(bǔ)上述缺陷的建議。

4.4測試結(jié)論：說明能否通過。

開發(fā)進(jìn)度月報(bào)

1報(bào)告時(shí)間及所處的開發(fā)階段

2工程進(jìn)度

2.1本月內(nèi)的主要活動

2.2實(shí)際進(jìn)展與計(jì)劃比較

3所用工時(shí)

按不同層次人員分別計(jì)時(shí)。

在項(xiàng)目開發(fā)過程中，應(yīng)該按要求編寫好十三種文檔，文檔編制要求具有針對性、精琬性、

清晰性、完整性、靈活性、可追溯性。

?可行性分析報(bào)告：說明該軟件開發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會因素上的可行性，評述為了

合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實(shí)施方案，說明并論證所選定實(shí)施方案的理由。

O項(xiàng)目開發(fā)計(jì)劃：為軟件項(xiàng)目實(shí)施方案制訂出具體計(jì)劃，應(yīng)該包括各部分工作的負(fù)責(zé)人員、開發(fā)的進(jìn)

度、開發(fā)經(jīng)費(fèi)的預(yù)算、所需的硬件及軟件資源等。

O軟件需求說明書（軟件規(guī)格說明書）：對所開發(fā)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳

細(xì)的說明。它是在用戶與開發(fā)人員雙方時(shí)軟件需求取得共同理解并達(dá)成協(xié)議的條件下編寫的，也是實(shí)施開

發(fā)工作的基礎(chǔ)。該說明書應(yīng)給出數(shù)據(jù)邏輯和數(shù)據(jù)采集的各項(xiàng)要求，為生成和維護(hù)系統(tǒng)數(shù)據(jù)文件做好準(zhǔn)備。

O概要設(shè)計(jì)說明書：該說明書是概要實(shí)際階段的工作成果，它應(yīng)說明功能分配、模塊劃分、程序的總

體結(jié)構(gòu)、輸入輸出以及接U設(shè)計(jì)、運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為詳細(xì)設(shè)計(jì)提供基砧。

0詳細(xì)設(shè)計(jì)說明書：著直描述每一模塊是怎樣實(shí)現(xiàn)的，包括實(shí)現(xiàn)算法、邏輯流程等。

0用戶操作手冊：本手冊詳細(xì)描述軟件的功能、性能和用戶界面，使用戶對如何使用該軟件得到具體

的了解,為操作人員提供該軟件各種運(yùn)行情況的有關(guān)知識，特別是操作方法的具體細(xì)節(jié)。

O測試計(jì)劃：為做好集成測試和驗(yàn)收測試，需為如何組織測試制訂實(shí)施計(jì)劃。計(jì)劃應(yīng)包括測試的內(nèi)容、

進(jìn)度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范圍等。

O測試分析報(bào)告：測試工作完成以后，應(yīng)提交測試計(jì)劃執(zhí)行情況的說明，對測試結(jié)果加以分折，并提

出測試的結(jié)論意見。

?開發(fā)進(jìn)度月報(bào)：該月報(bào)系軟件人員按月向管理部門提交的項(xiàng)目進(jìn)展情況報(bào)告，報(bào)告應(yīng)包括進(jìn)度計(jì)劃

與實(shí)際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個(gè)月的打算等。

o項(xiàng)目開發(fā)總結(jié)報(bào)告：軟件項(xiàng)目開發(fā)完成以后，應(yīng)與項(xiàng)目實(shí)施計(jì)劃對照，總結(jié)實(shí)際執(zhí)行的情況，如進(jìn)

度、成果、資源利用、成本和投入的人力，此外，還需對開發(fā)工作做出評價(jià)，總結(jié)出經(jīng)驗(yàn)和教訓(xùn)。

?軟件維護(hù)手冊：主要包括軟件系統(tǒng)說明、程序模塊說明、佛作環(huán)境、支持軟件的說明、維護(hù)過程的

說明，便于軟件的維護(hù)。

0軟件問題報(bào)告：指出軟件問題的登記情況，如日期、發(fā)現(xiàn)人、狀態(tài)、問題所屬模塊等，為軟件修改

提供準(zhǔn)備文檔。

O軟件修改報(bào)告：軟件產(chǎn)品投入運(yùn)行以后，發(fā)現(xiàn)了需對其進(jìn)行修正、更改等問題，應(yīng)將存在的詞題、

修改的考慮以及修改的影響做出詳細(xì)的描述，提交審批。

可行性分析報(bào)告

1引言

1.1編寫目的：闡明編寫可行性研究報(bào)告的目的，提出讀者對象.

1.2項(xiàng)目背景：應(yīng)包括

?所建議開發(fā)軟件的名稱

?項(xiàng)目的（工務(wù)提出者、開發(fā)者、用戶及實(shí)現(xiàn)軟件的單位

?項(xiàng)目與其他軟件或其他系統(tǒng)的關(guān)系。

1.3定義：列出文檔中用到的專門術(shù)語的定義和縮寫詞的原文。

1.4參考資料：列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括

?項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文

?與項(xiàng)目有關(guān)的已發(fā)表的資料

?文檔中所引用的資料，所采用的軟件標(biāo)準(zhǔn)或規(guī)范

2可行性研究的前提

2.1要求：列出并說明建議開發(fā)軟件的基本要求，如

?功能

?性能

?輸入/輸出

?基本的數(shù)據(jù)流程和處理流程

?安全與保密要求

?與軟件相關(guān)的其他系統(tǒng)

?完成日期

2.2目標(biāo)：可包括

?人力與設(shè)備費(fèi)用的節(jié)省

?處理速度的提高

?控制精度或生產(chǎn)力的提高

?管理信息服務(wù)的改進(jìn)

?決策系統(tǒng)的改進(jìn)

?人員工作效率的提高

2.3條件、假定和限制：可包括

?建議開發(fā)軟件運(yùn)行的最短壽命

?進(jìn)行顯然方案選擇比較的期限

?經(jīng)費(fèi)來源和使用限制

?法律和政策方面的限制

?硬件、軟件、運(yùn)行環(huán)境和開發(fā)環(huán)境的條件和限制

?可利用的信息和資源

?建議開發(fā)軟件投入使月的最遲時(shí)間

2.4可行性研究方法

2.5決定可行性的主要因素

3對現(xiàn)有系統(tǒng)的分析

3.1處理流程和數(shù)據(jù)流程

3.2工作負(fù)荷

3.3費(fèi)用支出：如人力、設(shè)備、空間、支持性服務(wù)、材料等項(xiàng)開支

3.4人員：列出所需人員的專業(yè)技術(shù)類別和數(shù)量

3.5設(shè)備

3.6局限性：說明現(xiàn)有系統(tǒng)存在的問題以及為什么需要開發(fā)新的系統(tǒng)

4所建議技術(shù)可行性分析

4.1對系統(tǒng)的簡要描述

4.2與現(xiàn)有系統(tǒng)比較的優(yōu)越性

4.3處理流程和數(shù)據(jù)流程

4.4采用建議系統(tǒng)可能帶來的影響

?對設(shè)備的膨響

?對現(xiàn)有軟件的影響

?對用戶的影響

?對系統(tǒng)運(yùn)行的影響

?對開發(fā)環(huán)境的影響

?對經(jīng)費(fèi)支出的影響

4.5技術(shù)可行性評價(jià):包括

?在限制條件下，功能目的是否達(dá)到

?利用現(xiàn)有技術(shù)，功能目的是否達(dá)到

?對開發(fā)人員數(shù)量和質(zhì)目的要求，并說明能否滿足

?在規(guī)定的期限內(nèi)，開發(fā)能否完成

5所建議系統(tǒng)經(jīng)濟(jì)可行性分析

5.1支出

5.2效益

5.3收益/投資比

5.4投資回收周期

5.5敏感性分析：指一些關(guān)鍵性因素，如：

?系統(tǒng)生存周期長短

?系統(tǒng)工作負(fù)荷量

?處理速度要求

?設(shè)備和軟件配置變化對支出和效益的影響等的分析

6社會因素可行性分析

6.1法律因素:如

?合同責(zé)任

?侵犯專利權(quán)

?侵犯版權(quán)

6.2用戶使用可行性：如

?用戶單位的行政管理

?工作制度

?人員素質(zhì)等能否滿足耍求

7其他可供選擇的方案

逐個(gè)闡明其它可供選擇的方案，并重點(diǎn)說明未被推薦的理山.

8結(jié)論意見

?可著手組織開發(fā)

?需等待若干條件具備后才能開發(fā)

?需對開發(fā)目標(biāo)進(jìn)行某些修改

?不能進(jìn)行或不必進(jìn)行

?其它

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

1引言

1.1編寫目的：闡明編寫可行性研究報(bào)告的目的，提出讀者對象

1.2項(xiàng)目背景：應(yīng)包括

?項(xiàng)目的委托單位、開發(fā)單位和主管部門；

?該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。

1.3定義：列出文檔中用到的專門術(shù)語的定義和縮寫詞的原文

1.4參考資料：可包括：

?項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文

?文檔所引用的資料、規(guī)范等

?列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源：

2項(xiàng)目概述

2.1工作內(nèi)容:簡要說明項(xiàng)目的各項(xiàng)主要工作，介紹所開發(fā)軟件的功能、性能等：若不編寫可行性研窕報(bào)告:

則應(yīng)在本節(jié)給出較詳細(xì)的介紹；

2.2條件與限制：闡明為完成項(xiàng)目應(yīng)具備的條件、開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件。必要時(shí)還

應(yīng)說明用戶及分合同承擔(dān)的工作、完成期限及其他條件與限制。

2.3產(chǎn)品

2.3.1程序：列出應(yīng)交付的程序名稱、使用的語言及存儲形式。

2.3.2文檔：列出應(yīng)交付的文檔。

2.4運(yùn)行環(huán)境：應(yīng)包括硬件環(huán)境、軟件環(huán)境。

2.5服務(wù)：闡明開發(fā)單位可向用戶提供的服務(wù)。如人員培訓(xùn)、安裝、保修、維護(hù)和其他運(yùn)行支持。

2.6驗(yàn)收標(biāo)準(zhǔn)

3實(shí)施計(jì)劃

3.1任務(wù)分解：任務(wù)的劃分及各項(xiàng)任務(wù)的負(fù)責(zé)人。

3.2進(jìn)度：按階段完成的項(xiàng)目，用圖表說明開始時(shí)間、完成時(shí)間＜

3.3預(yù)算

3.4關(guān)鍵問題：說明可能影響項(xiàng)目的關(guān)鍵問題，如設(shè)備條件、技術(shù)難點(diǎn)或其他風(fēng)險(xiǎn)因素，并說明對策。

4人員組織及分工

5交付期限

6專題計(jì)劃要點(diǎn)

如測試計(jì)劃、質(zhì)量保證計(jì)劃、配置管理計(jì)劃、人員培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等。

6.1變量使用

1、不允許隨意定義全局變量。

2、一個(gè)變量只能有一個(gè)用途；變量的用途必須和變量的名稱保材一致v

3、所有變量都必須在類和函數(shù)最前面定義，并分類排列。

6.2數(shù)據(jù)庫操作

1、瓷找數(shù)據(jù)庫表或視圖時(shí)，只能取出確實(shí)需要的那些字段。

2、使用無關(guān)聯(lián)子查詢，而不要使用關(guān)聯(lián)子查詢。

3、清楚明白地使用列名，而大能使用列的序號。

4、ASP操作時(shí)只在必要時(shí)創(chuàng)建RecordSet對象

6.3對象使用

盡可能晚地創(chuàng)建對象，并且盡可能早地釋放它。

6.4模塊設(shè)計(jì)原則

1、不允許隨意定義公用的函數(shù)和類。

2、函數(shù)功能單一，不允許一人函數(shù)實(shí)現(xiàn)兩個(gè)及兩個(gè)以上的功能。

3、不能在函數(shù)內(nèi)部使用全局變量，如要使用全局變量，應(yīng)轉(zhuǎn)化為局部變量。

4、函數(shù)與函數(shù)之間只允許存在包含關(guān)系，而不允許存在交叉關(guān)系。即兩者之間只存在單方向的調(diào)用與被調(diào)

用，不存在雙向的調(diào)用與被調(diào)用。

結(jié)構(gòu)化要求

1、用IF語句來強(qiáng)調(diào)只執(zhí)行兩組語句中的一組。禁止ELSEGOTO和ELSERETURN。

2、用CASE實(shí)現(xiàn)多路分支而大是多個(gè)IF

3、避免從循環(huán)引出多個(gè)出口。

4、函數(shù)只有一個(gè)出口。

5、不使用條件賦值語句。

6、避免不必要的分支。

7、不要輕易用條件分支去替換邏輯表達(dá)式

6.6函數(shù)返回值原則

1、避免使用結(jié)構(gòu)體等復(fù)雜類型

2、使用邏輯類型：該函數(shù)只希要獲得成功或者失敗的返回信息時(shí)候

3、使用int類型：錯(cuò)誤代碼用負(fù)數(shù)表示，成功返回0

七、數(shù)據(jù)庫命名規(guī)范：

1、表命名：用一個(gè)或三個(gè)以、英文單詞組成，單詞首字母大寫，如：Departmentusers：

2、表主鍵名稱為：表名+ID,如Document表的主鍵名為：DocumentID

3、存儲過程命名：表名+方法，如：p_my_NewsAdd,p_my_Newsllpdate:

4、視圖命名：View_表名，如:ViewNews;

5、Status為表中狀態(tài)的列名，默認(rèn)值為0.在表中刪除操作將會改變Status的值而不真實(shí)刪除該記錄：

6、Checkintime為記錄添加時(shí)間列，默認(rèn)值為系統(tǒng)時(shí)間；

7、表、存儲過程、視圖等對象的所有都為db。，不要使用數(shù)據(jù)庫用戶名，這樣會影響數(shù)據(jù)庫用戶的更改。

八、注釋規(guī)范

8.1概述

1、注釋要求英文及英文的標(biāo)點(diǎn)符號。

2、注釋中，應(yīng)標(biāo)明對象的完整的名稱及其用途，但應(yīng)避免對代碼過于詳細(xì)的描述。

3、每行注拜的最大長度為100個(gè)字符0

4、將注釋與注釋分隔符用一人空格分開。

5、不允許給注釋加外框。

6、編碼的同時(shí)書寫注釋。

7、重要變量必須有注釋。

8、變量注釋和變量在同一行，所有注釋必須對齊，與變量分開至少四個(gè)“空格”鍵。例：

intm_iLevel,m_iCount;//m_iLevel....treelevel

//m_iCount….countoftree