軟件項(xiàng)目管理-項(xiàng)目手冊(cè)編寫和提交規(guī)范

項(xiàng)名稱

項(xiàng)目手冊(cè)編寫和提交規(guī)范

主題：項(xiàng)目手冊(cè)編寫和提交規(guī)范

項(xiàng)目名稱：項(xiàng)目名稱

撰寫單位：

作者：

版本號(hào)：

日期：

審核

功能姓名部門簽名日期

文檔歷史

版本修改原因修改人日期

0.1創(chuàng)建

0.2修改

0.3格式調(diào)整

0.4語(yǔ)句調(diào)整

概要

目的

1.描述項(xiàng)目手冊(cè)的目錄結(jié)構(gòu)，以及對(duì)相關(guān)文檔內(nèi)容的要求。

2.提出項(xiàng)目手冊(cè)相關(guān)文癖交和更新的要求。

約定

藍(lán)色的文字是需要說(shuō)明和規(guī)范的條目：例如：A.程序文件

粉紅的文字說(shuō)明性信息，需要了解：例如：說(shuō)明：

紅色的文字重要的信息，需求特別關(guān)注：例如：1、要求：2、更新目錄：3、提交時(shí)間：

綠色的文字建議性的信息，建議關(guān)注：例如：建議：

目錄結(jié)構(gòu)描述

根目錄：

所有客戶資料分產(chǎn)品存放在\SD\技術(shù)部\Engineering\Projects\下面

例如：EP0S3.C的產(chǎn)品就放在\SD\技術(shù)部\Enginaering\Projects\3.0項(xiàng)目、下面

客戶目錄：

項(xiàng)目名稱開(kāi)頭的文件夾，比如："金華中洋”

主目錄：

位于項(xiàng)目名稱目錄下的第一層目錄：

名邨▲___________________

/妙_程序文件：

亡方至祠.丙春■■

?5案卻

客戶信息

◎EJ?級(jí)報(bào)告

0_項(xiàng)目管理

心G，護(hù)文檔

0H_需求文檔

白匚項(xiàng)目手冊(cè)

口2戊他資料

圖dir.txt

index.htm

圖J更新記錄.dot

index.htm

目錄結(jié)構(gòu)入口，可以從這里進(jìn)入到項(xiàng)目手冊(cè)的各個(gè)子目錄，在模版里就已經(jīng)有了，不需要變更。

后面子目錄也基本也都包含此文件。

dir.txt

本目錄下的一些功能使用說(shuō)明，在模版里就已經(jīng)有了，不需要變更。后面子目錄也基本也都包含

此文件。

更新記錄.dot

說(shuō)明：記錄對(duì)于本根目錄以下的任^可變動(dòng)。

要求：記錄時(shí)間、人員和更新目錄；

建議：記錄更新內(nèi)容。

其他子目錄：參考其下任意一個(gè)項(xiàng)目的目錄結(jié)構(gòu)。

明細(xì)內(nèi)容

'項(xiàng)目名稱2

人程序文件

項(xiàng)目前后臺(tái)程序、源程序、驅(qū)動(dòng)、模板、查詢將存放在這里。

fg

說(shuō)明：根據(jù)客戶POS機(jī)型號(hào)的不同,分別在FG目錄下建立不同的BIN目錄。

要求：1、BIN目錄客戶的前臺(tái)一致，包括POS程序和驅(qū)動(dòng)程序；2、在BIN目錄下再存放前臺(tái)

windows目錄的Efg31.ini文件。

建議：1、建議在型號(hào)目錄下增加說(shuō)明文件，名稱可取"說(shuō)明TXT";2、如果有驅(qū)動(dòng)的源程

序，建議在POS機(jī)型號(hào)里面建立一個(gè)DRV目錄，然后把源程序存放在那里.

Epos31

說(shuō)明：本處存放客戶總部的EPOS32目錄復(fù)制。增加一個(gè)MDQUERY,存放門店的查詢?？偛?/p>

和門店導(dǎo)出的MENU菜單放在此目錄里。其中的Peri目錄要包括所有門店設(shè)置的DB。

要求：同上面說(shuō)明。

建議：建議此目錄下的BIN目錄可以作為在升級(jí)、測(cè)試之前編譯程序存放的目錄。

PrintBill

說(shuō)明：存放打印模板的原程序或FRF格式文件。因?yàn)榇嬖贒elphi3和Delphi5。需要注明是不是

Delphi5，默認(rèn)為Delphi3。

要求：注明是Delphis還是為Delphi?。注明客戶維護(hù)還是我們維護(hù)。

Source

說(shuō)明：項(xiàng)目當(dāng)前客戶端主程序的源程序，以及前次升級(jí)的源程序?qū)⒋娣旁谶@里。

要求：目錄名取法為"SOURCE一日期一版本號(hào)"，其中日期為提交客戶的日期（這個(gè)日期可以是

一個(gè)大概的），版本號(hào)為我們發(fā)布的版本號(hào)。如果有程序定制，要求增加"定制說(shuō)明.TXT"。如

果有IC卡和合約管理把程序放41」"SOURCE.日期_版本號(hào)”目錄里，并加入到E3.bpgn,便于

一起編譯。

建議：L增加一個(gè)Library目錄，用于存放發(fā)布時(shí)的兩個(gè)dcp文件，以及編譯的中間文件。

2、建立一個(gè)SOURCE目錄，作為升級(jí)前測(cè)試源程序的臨時(shí)目錄。例如，給客戶單獨(dú)

升級(jí)某個(gè)任務(wù)單時(shí)使用,確認(rèn)沒(méi)有問(wèn)題后，再把SOURCE同步到上次的"SOURCE一日期一

版本號(hào)”目錄中。

3、定制的程序在下一個(gè)版本發(fā)布前，原則上要合并到發(fā)布版本里。

Sp

說(shuō)明：存儲(chǔ)過(guò)程將存放在這里。里面分sp_定制，"sp一日期一版本號(hào)”

要求：1、如果有定制的存儲(chǔ)過(guò)程放在目錄"sp一定制"中。定制的存儲(chǔ)過(guò)程里面定制的內(nèi)容全

部要以以下格式：

--開(kāi)始定制2005.01.01byXXX

一定制的功能和目的說(shuō)明

此處為定制的內(nèi)容。

一結(jié)束定制2005.01.01byXXX

2、"sp.日期一版本號(hào)”目錄存放這個(gè)客戶目前使用的標(biāo)準(zhǔn)存儲(chǔ)過(guò)程全量。包括升級(jí)更新的和沒(méi)

有更新的，不包括定制內(nèi)容。其中日期為提交給客戶的日期。

建議：平常的任務(wù)單升級(jí)，只需要把需要更新的存儲(chǔ)過(guò)程想蓋到當(dāng)前目錄中的文件。

在進(jìn)行大版本升級(jí)的時(shí)候，把上一次的目錄復(fù)制過(guò)來(lái)。然后再把升級(jí)的存儲(chǔ)過(guò)程替換到目

錄中

B_定制內(nèi)容

客戶化定制內(nèi)容將存放在這里，主要存放定制內(nèi)容文檔，對(duì)應(yīng)源程序和使用說(shuō)明等。已經(jīng)預(yù)設(shè)了一

些目錄.如果還有不能包括的東西，先放到Z.其他目錄下面。

A_備份方案

說(shuō)明：提供客戶的備份方案文檔

要求：一定要寫一份客戶的備份方案。包括SQL的備份和拷貝備份，不包括轉(zhuǎn)儲(chǔ)。

建議：趁這個(gè)機(jī)會(huì)，為客戶整理一下備份方案。

B_轉(zhuǎn)儲(chǔ)方案

說(shuō)明：如果有用數(shù)據(jù)轉(zhuǎn)儲(chǔ)，存放轉(zhuǎn)儲(chǔ)的程序，存放轉(zhuǎn)儲(chǔ)方案以及轉(zhuǎn)儲(chǔ)的方案

要求：須包括轉(zhuǎn)儲(chǔ)的程序，轉(zhuǎn)儲(chǔ)的方案和轉(zhuǎn)儲(chǔ)后數(shù)據(jù)清除方案。

建議：把數(shù)據(jù)清除的腳本和說(shuō)明也存放在此目錄下。

C_系統(tǒng)參數(shù)

說(shuō)明：存放客戶總部的SYSTEM,EOPTION和STORE。

建議：建議使用ACCESS來(lái)記錄，可以在數(shù)據(jù)庫(kù)中做一個(gè)DTS包，去客戶的時(shí)候運(yùn)行一下這個(gè)

表，然后再把ACCESS文件放到這里。

D_財(cái)務(wù)接口

說(shuō)明：財(cái)務(wù)接口程序、憑證接口腳本和說(shuō)明文檔

要求：要求財(cái)務(wù)接口和憑證接口腳本。

建議：建議提供憑證說(shuō)明文檔

E_新開(kāi)門店服務(wù)器安裝

說(shuō)明：對(duì)于超市門店，存放新開(kāi)門店服務(wù)器的安裝方法步驟以及所需要的資料或腳本。

要求：L提供開(kāi)門店安裝方法步驟詳細(xì)說(shuō)明文檔，并注明客戶執(zhí)行的步驟和我們執(zhí)行的步

驟。

2、需要提供客戶執(zhí)行的腳本和需要導(dǎo)入數(shù)據(jù)的表名。我們執(zhí)行所需要的腳本。

建議：一般安裝方法建議使用客戶的標(biāo)準(zhǔn)庫(kù)，在日常要維護(hù)標(biāo)準(zhǔn)庫(kù)與主數(shù)據(jù)庫(kù)同步升級(jí)。

F_小工具

說(shuō)明：此處備份一些小工具，包括用于維護(hù)和應(yīng)用的小工具以及源程序，以及對(duì)于這種特殊小

工具的使用方法和背景說(shuō)明。

z其它

說(shuō)明：定制的東西無(wú)法歸類的，存放在這里。

C_方案文檔

實(shí)施過(guò)程中使用的一些文檔和方案將存放在這里。實(shí)施結(jié)束后本目錄基本不再變動(dòng)。

A方案

說(shuō)明：方案存放位置

B_流程

說(shuō)明：切換的時(shí)候的建議流程和確定流程，以及之后修改的流程以及操作手冊(cè)。

C培訓(xùn)

說(shuō)明:培訓(xùn)的計(jì)劃、資料和考試等資料存放于此

D一崗位職責(zé)

說(shuō)明:切換時(shí)或切換前提供給客戶的.以及在之個(gè)過(guò)程中最后確定的身位職責(zé)說(shuō)明文檔

E_系統(tǒng)切換

說(shuō)明：存放統(tǒng)切換時(shí)保存的一些原始文檔

F_資料格式

說(shuō)明：切換時(shí)基本資料的格式、打印格式將存放在這里。

D_客戶信息

客戶的店表資料，遠(yuǎn)程維護(hù)方式將存放在這里。

遠(yuǎn)程連接方式

說(shuō)明:記錄我們婦何遠(yuǎn)程連接客戶方法和相關(guān)用戶和密碼以及相關(guān)人員的聯(lián)系方式。

要求：達(dá)到其他項(xiàng)目經(jīng)理根據(jù)這個(gè)文件就能夠遠(yuǎn)程連到客戶那里去維護(hù)。格式按模版中的樣

子。

建議：建議使用nyf文件，因?yàn)樗梢杂糜谀杲K的時(shí)唉可以多個(gè)文件導(dǎo)入合并生成一個(gè)文件。以

便過(guò)年的值班人員使用。

店表資料

說(shuō)明：存放客戶門店的信息，包括內(nèi)容詳細(xì)看"店表資料.xlt".

要求：要求有門店GID，機(jī)器名（或IP）和EPOS用戶和密碼，操作系統(tǒng)用戶和密碼。

建議：建議信息增寫完整。此門店資料可以用于以后升級(jí)門店等時(shí)候的控制文件，以記錄哪一

些門店做完了，哪一些門店還沒(méi)有做完。

E_升級(jí)報(bào)告

升級(jí)報(bào)告、腳本等將存放在這里。

版本升級(jí)說(shuō)明目錄存放的是跨版本升級(jí)的一些說(shuō)明文檔和模板，以便升級(jí)人員清楚做些什么和如何

做。

升級(jí)目錄取法：YYYYMMDD（取升級(jí)時(shí)間），如果是大版本升級(jí)，則后面加上版本號(hào)。例如：升級(jí)

時(shí)間為2004年12月14號(hào)，只是升級(jí)小任務(wù)單，則取為20041214。又如：升級(jí)時(shí)間為2004年12月31

號(hào),升級(jí)版本為20040806和20041228,則取為20041231_220041228。

1_版本升級(jí)說(shuō)明

說(shuō)明：包括兩個(gè)文檔。"版本升級(jí)手冊(cè)doc"用于告訴我們升級(jí)人員該做些什么和如何做。

"安裝、升級(jí)跟蹤文檔Ms”文件是一個(gè)模版，用于控制升級(jí)測(cè)試過(guò)程。此目錄不需要項(xiàng)目經(jīng)理

提供，可以提出改進(jìn)意見(jiàn)，統(tǒng)一修改。

建議：建議在升級(jí)過(guò)程中用"安裝、升級(jí)跟蹤文檔.Ms”,以控制升級(jí)測(cè)試過(guò)程，減少遺漏和提

高升級(jí)效率。

20041120_20040806

說(shuō)明：2004112C代表升級(jí)時(shí)間，20040806代表這一次升級(jí)中最大的發(fā)布版本號(hào)。目錄中要包

括升級(jí)的程序，腳本和腳本執(zhí)行順序，升級(jí)報(bào)告.

要求：要求升級(jí)時(shí)目錄按這樣取。

建議：建議按升級(jí)包的打包路徑來(lái)存放。

20041214

說(shuō)明：20041214代表升級(jí)的時(shí)間，后面沒(méi)有版本號(hào)表示不是大版本升級(jí)。目錄中要刨舌升級(jí)的

程序，腳本和腳本執(zhí)行順序，升級(jí)報(bào)告。

要求：要求升級(jí)時(shí)目錄按這樣取。

建議：建議腳本名稱用1_、2一開(kāi)頭，表示腳本執(zhí)行的順序。

EPOS3升級(jí)報(bào)告說(shuō)明：按照模版把內(nèi)部填完整

要求：版本號(hào)和任務(wù)單號(hào)。有的話需要填寫完整

建議：建議其它的內(nèi)容也填寫完整，并填寫主要應(yīng)用更新了哪一些新功能。

F」頁(yè)目管理

存放項(xiàng)目管理規(guī)范中需要的管理文檔，包括項(xiàng)目章程、計(jì)劃書等。

XX子項(xiàng)目為在一介大項(xiàng)目中的子項(xiàng)目，它是一個(gè)管理過(guò)程。具體見(jiàn)項(xiàng)目管理規(guī)范。

A_系統(tǒng)實(shí)施項(xiàng)目

說(shuō)明：項(xiàng)目最初實(shí)施的控制文檔。具體目錄規(guī)則參見(jiàn)項(xiàng)目管理規(guī)范相關(guān)要求。

XX子項(xiàng)目

說(shuō)明：在這個(gè)項(xiàng)目之后出現(xiàn)在子項(xiàng)目.

G_維護(hù)文檔

現(xiàn)場(chǎng)維護(hù)記錄，非需求，非實(shí)施的一般維護(hù)文檔將存放在這里，包括解決什么問(wèn)題、維護(hù)記錄和腳

本?，F(xiàn)場(chǎng)維護(hù)記錄也存放在這里。

要求：目錄名稱用YYYYMMDD+主要解決問(wèn)題。如：20050401積分加倍活動(dòng)

說(shuō)明：對(duì)于日常維護(hù)文檔、腳本存放在此目錄下。一天處理多個(gè)問(wèn)題，須分目錄存放。

建議：建議維護(hù)的腳本在存放，和增加維護(hù)說(shuō)明。說(shuō)明維護(hù)處理的問(wèn)題和方法。

H_需求文檔

說(shuō)明：每一個(gè)項(xiàng)目的需求文檔放在這里，客戶提交過(guò)來(lái)的文件放在需求原始資料里。然后我們把它整

理到開(kāi)發(fā)部發(fā)布的收集模版里。

要求：所有的客戶的所有需求都要在此找到。

建議：建議以開(kāi)發(fā)的需求收集整理。

L項(xiàng)目手冊(cè)

這是其中一個(gè)入口，很多地方可以從這里鏈接。

說(shuō)明：參考原來(lái)的項(xiàng)目手冊(cè)編寫

要求：把項(xiàng)目手冊(cè)里的填寫完整

建議：建議增加鏈接；

z_其他資料

其他沒(méi)有歸納的資料，包括有原來(lái)的項(xiàng)目階段總結(jié)。

說(shuō)明：其他沒(méi)有歸納的資料，包括有原來(lái)的項(xiàng)目階段總結(jié)

文檔要求清單

為方便大家查看和記憶，將以上目錄結(jié)構(gòu)的要求部分按表格形式整理出來(lái)。

位置要求

A.程序文件\fg1、BIN目錄客戶的前臺(tái)一致，包括POS程序和驅(qū)動(dòng)程序；

2、在BIN目錄下再存放前臺(tái)windows目錄的Efg31.ini文件。

人_程序文件\Epos31本處存放客戶總部的EPOS32目錄復(fù)制。增加一個(gè)MDQUERY,存放門店的查詢

總部和門店導(dǎo)出的MENU菜單放在此目錄里。其中的Peri目錄要包括所有門店i

A_程序文件\printbill注明是Delphi5還是為Delphi，注明客戶維護(hù)還是我們維護(hù)。

4_程序文件\source目錄名取法為"SOURCE.日期一版本號(hào)”號(hào)。

如果有程序定制，要求增加"定制說(shuō)明.TXT".

如果有IC卡和合約管理把程序放到"SOURCE一日期一版本號(hào)”目錄里，

并加入到E3.bpg中，便于一起編譯。

人_程序文件\sp1、如果有定制的存儲(chǔ)過(guò)程放在目錄"sp一定制"中。

2、"sp一日期一版本號(hào)”目錄存放這個(gè)客戶目前使用的程序過(guò)程全量.

B_定制內(nèi)容\A_備份方案一定要寫一份客戶的備份方案。包括SQL的備份和拷貝備份，不包括轉(zhuǎn)儲(chǔ)。

B_定制內(nèi)容\B_轉(zhuǎn)儲(chǔ)方案如果有用轉(zhuǎn)儲(chǔ)，在寫出轉(zhuǎn)儲(chǔ)的備份方案和數(shù)據(jù)清除方案。

B一定制內(nèi)容\D_財(cái)務(wù)接口要求財(cái)務(wù)接口和憑證接口腳本。

B.定制內(nèi)容\E_新開(kāi)門店L提供開(kāi)門店安裝方法步驟詳細(xì)說(shuō)明文檔，并注明客戶執(zhí)行的步驟和我們執(zhí)行1

服務(wù)器安裝2、需要提供客戶執(zhí)行的腳本和需要導(dǎo)入數(shù)據(jù)的表名。我們執(zhí)行所需要的腳本。

3、提供安裝門店服務(wù)器安裝所需要的標(biāo)準(zhǔn)庫(kù)或表結(jié)構(gòu)和存儲(chǔ)過(guò)程的腳本。

口_客戶信息\遠(yuǎn)程連接方式達(dá)到其他項(xiàng)目經(jīng)理根據(jù)這個(gè)文件就能夠遠(yuǎn)程連到客戶那里去維護(hù)。格式按模版中

D_客戶信息腦表資料要求有門店GID,機(jī)器名（或IP）和EPOS用戶和密碼，操作系統(tǒng)用戶和密碼。

E.升級(jí)報(bào)告\20041120升級(jí)目錄取法,升級(jí)時(shí)間+最大一個(gè)升級(jí)版本時(shí)間，如果沒(méi)有版本則不取

_220041228例如：升級(jí)時(shí)間為2004年12月14號(hào)，只是升級(jí)小任務(wù)單,則取為20041214。

例如：升級(jí)時(shí)間為2004年12月31號(hào)，升級(jí)版本為20040806和20041228,

貝！J取為20041120_220041228。

E.升級(jí)報(bào)告\EP0S3升級(jí)報(bào)告版本號(hào)和任務(wù)單號(hào)。有的話需要填寫完整

H_需求文檔所有的客戶的所有需求都要在此找到。

L項(xiàng)目手冊(cè)把項(xiàng)目手冊(cè)里的填寫完整

提交規(guī)范

最初的項(xiàng)目實(shí)施

更新目錄：對(duì)于最初的項(xiàng)目實(shí)施必須提交以下目錄的內(nèi)容：

?.\A_程序文件下的所有子目錄；

AB貢制內(nèi)容目錄下的A_備份方案、C_系統(tǒng)參數(shù)、E_新開(kāi)門店服務(wù)器安裝（超市客戶）；

?.\C方案文檔目錄下的所有子目錄；

?.\D_客戶信息;

..\F_項(xiàng)目管理\A_系統(tǒng)實(shí)施項(xiàng)