項名稱

項目手冊編寫和提交規(guī)范

主題：項目手冊編寫和提交規(guī)范

項目名稱：項目名稱

撰寫單位：

作者：

版本號：

日期：

審核

功能姓名部門簽名日期

文檔歷史

版本修改原因修改人日期

0.1創(chuàng)建

0.2修改

0.3格式調整

0.4語句調整

概要

目的

1.描述項目手冊的目錄結構，以及對相關文檔內容的要求。

2.提出項目手冊相關文癖交和更新的要求。

約定

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

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

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

綠色的文字建議性的信息，建議關注：例如：建議：

目錄結構描述

根目錄：

所有客戶資料分產品存放在\SD\技術部\Engineering\Projects\下面

例如：EP0S3.C的產品就放在\SD\技術部\Enginaering\Projects\3.0項目、下面

客戶目錄：

項目名稱開頭的文件夾，比如："金華中洋”

主目錄：

位于項目名稱目錄下的第一層目錄：

名邨▲___________________

/妙_程序文件：

亡方至祠.丙春■■

?5案卻

客戶信息

◎EJ?級報告

0_項目管理

心G，護文檔

0H_需求文檔

白匚項目手冊

口2戊他資料

圖dir.txt

index.htm

圖J更新記錄.dot

index.htm

目錄結構入口，可以從這里進入到項目手冊的各個子目錄，在模版里就已經有了，不需要變更。

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

dir.txt

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

此文件。

更新記錄.dot

說明：記錄對于本根目錄以下的任^可變動。

要求：記錄時間、人員和更新目錄；

建議：記錄更新內容。

其他子目錄：參考其下任意一個項目的目錄結構。

明細內容

'項目名稱2

人程序文件

項目前后臺程序、源程序、驅動、模板、查詢將存放在這里。

fg

說明：根據客戶POS機型號的不同,分別在FG目錄下建立不同的BIN目錄。

要求：1、BIN目錄客戶的前臺一致，包括POS程序和驅動程序；2、在BIN目錄下再存放前臺

windows目錄的Efg31.ini文件。

建議：1、建議在型號目錄下增加說明文件，名稱可取"說明TXT";2、如果有驅動的源程

序，建議在POS機型號里面建立一個DRV目錄，然后把源程序存放在那里.

Epos31

說明：本處存放客戶總部的EPOS32目錄復制。增加一個MDQUERY,存放門店的查詢。總部

和門店導出的MENU菜單放在此目錄里。其中的Peri目錄要包括所有門店設置的DB。

要求：同上面說明。

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

PrintBill

說明：存放打印模板的原程序或FRF格式文件。因為存在Delphi3和Delphi5。需要注明是不是

Delphi5，默認為Delphi3。

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

Source

說明：項目當前客戶端主程序的源程序，以及前次升級的源程序將存放在這里。

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

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

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

一起編譯。

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

2、建立一個SOURCE目錄，作為升級前測試源程序的臨時目錄。例如，給客戶單獨

升級某個任務單時使用,確認沒有問題后，再把SOURCE同步到上次的"SOURCE一日期一

版本號”目錄中。

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

Sp

說明：存儲過程將存放在這里。里面分sp_定制，"sp一日期一版本號”

要求：1、如果有定制的存儲過程放在目錄"sp一定制"中。定制的存儲過程里面定制的內容全

部要以以下格式：

--開始定制2005.01.01byXXX

一定制的功能和目的說明

此處為定制的內容。

一結束定制2005.01.01byXXX

2、"sp.日期一版本號”目錄存放這個客戶目前使用的標準存儲過程全量。包括升級更新的和沒

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

建議：平常的任務單升級，只需要把需要更新的存儲過程想蓋到當前目錄中的文件。

在進行大版本升級的時候，把上一次的目錄復制過來。然后再把升級的存儲過程替換到目

錄中

B_定制內容

客戶化定制內容將存放在這里，主要存放定制內容文檔，對應源程序和使用說明等。已經預設了一

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

A_備份方案

說明：提供客戶的備份方案文檔

要求：一定要寫一份客戶的備份方案。包括SQL的備份和拷貝備份，不包括轉儲。

建議：趁這個機會，為客戶整理一下備份方案。

B_轉儲方案

說明：如果有用數據轉儲，存放轉儲的程序，存放轉儲方案以及轉儲的方案

要求：須包括轉儲的程序，轉儲的方案和轉儲后數據清除方案。

建議：把數據清除的腳本和說明也存放在此目錄下。

C_系統(tǒng)參數

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

建議：建議使用ACCESS來記錄，可以在數據庫中做一個DTS包，去客戶的時候運行一下這個

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

D_財務接口

說明：財務接口程序、憑證接口腳本和說明文檔

要求：要求財務接口和憑證接口腳本。

建議：建議提供憑證說明文檔

E_新開門店服務器安裝

說明：對于超市門店，存放新開門店服務器的安裝方法步驟以及所需要的資料或腳本。

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

驟。

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

建議：一般安裝方法建議使用客戶的標準庫，在日常要維護標準庫與主數據庫同步升級。

F_小工具

說明：此處備份一些小工具，包括用于維護和應用的小工具以及源程序，以及對于這種特殊小

工具的使用方法和背景說明。

z其它

說明：定制的東西無法歸類的，存放在這里。

C_方案文檔

實施過程中使用的一些文檔和方案將存放在這里。實施結束后本目錄基本不再變動。

A方案

說明：方案存放位置

B_流程

說明：切換的時候的建議流程和確定流程，以及之后修改的流程以及操作手冊。

C培訓

說明:培訓的計劃、資料和考試等資料存放于此

D一崗位職責

說明:切換時或切換前提供給客戶的.以及在之個過程中最后確定的身位職責說明文檔

E_系統(tǒng)切換

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

F_資料格式

說明：切換時基本資料的格式、打印格式將存放在這里。

D_客戶信息

客戶的店表資料，遠程維護方式將存放在這里。

遠程連接方式

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

要求：達到其他項目經理根據這個文件就能夠遠程連到客戶那里去維護。格式按模版中的樣

子。

建議：建議使用nyf文件，因為它可以用于年終的時唉可以多個文件導入合并生成一個文件。以

便過年的值班人員使用。

店表資料

說明：存放客戶門店的信息，包括內容詳細看"店表資料.xlt".

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

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

些門店做完了，哪一些門店還沒有做完。

E_升級報告

升級報告、腳本等將存放在這里。

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

做。

升級目錄取法：YYYYMMDD（取升級時間），如果是大版本升級，則后面加上版本號。例如：升級

時間為2004年12月14號，只是升級小任務單，則取為20041214。又如：升級時間為2004年12月31

號,升級版本為20040806和20041228,則取為20041231_220041228。

1_版本升級說明

說明：包括兩個文檔。"版本升級手冊doc"用于告訴我們升級人員該做些什么和如何做。

"安裝、升級跟蹤文檔Ms”文件是一個模版，用于控制升級測試過程。此目錄不需要項目經理

提供，可以提出改進意見，統(tǒng)一修改。

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

高升級效率。

20041120_20040806

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

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

要求：要求升級時目錄按這樣取。

建議：建議按升級包的打包路徑來存放。

20041214

說明：20041214代表升級的時間，后面沒有版本號表示不是大版本升級。目錄中要刨舌升級的

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

要求：要求升級時目錄按這樣取。

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

EPOS3升級報告說明：按照模版把內部填完整

要求：版本號和任務單號。有的話需要填寫完整

建議：建議其它的內容也填寫完整，并填寫主要應用更新了哪一些新功能。

F」頁目管理

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

XX子項目為在一介大項目中的子項目，它是一個管理過程。具體見項目管理規(guī)范。

A_系統(tǒng)實施項目

說明：項目最初實施的控制文檔。具體目錄規(guī)則參見項目管理規(guī)范相關要求。

XX子項目

說明：在這個項目之后出現(xiàn)在子項目.

G_維護文檔

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

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

要求：目錄名稱用YYYYMMDD+主要解決問題。如：20050401積分加倍活動

說明：對于日常維護文檔、腳本存放在此目錄下。一天處理多個問題，須分目錄存放。

建議：建議維護的腳本在存放，和增加維護說明。說明維護處理的問題和方法。

H_需求文檔

說明：每一個項目的需求文檔放在這里，客戶提交過來的文件放在需求原始資料里。然后我們把它整

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

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

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

L項目手冊

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

說明：參考原來的項目手冊編寫

要求：把項目手冊里的填寫完整

建議：建議增加鏈接；

z_其他資料

其他沒有歸納的資料，包括有原來的項目階段總結。

說明：其他沒有歸納的資料，包括有原來的項目階段總結

文檔要求清單

為方便大家查看和記憶，將以上目錄結構的要求部分按表格形式整理出來。

位置要求

A.程序文件\fg1、BIN目錄客戶的前臺一致，包括POS程序和驅動程序；

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

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

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

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

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

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

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

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

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

2、"sp一日期一版本號”目錄存放這個客戶目前使用的程序過程全量.

B_定制內容\A_備份方案一定要寫一份客戶的備份方案。包括SQL的備份和拷貝備份，不包括轉儲。

B_定制內容\B_轉儲方案如果有用轉儲，在寫出轉儲的備份方案和數據清除方案。

B一定制內容\D_財務接口要求財務接口和憑證接口腳本。

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

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

3、提供安裝門店服務器安裝所需要的標準庫或表結構和存儲過程的腳本。

口_客戶信息\遠程連接方式達到其他項目經理根據這個文件就能夠遠程連到客戶那里去維護。格式按模版中

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

E.升級報告\20041120升級目錄取法,升級時間+最大一個升級版本時間，如果沒有版本則不取

_220041228例如：升級時間為2004年12月14號，只是升級小任務單,則取為20041214。

例如：升級時間為2004年12月31號，升級版本為20040806和20041228,

貝！J取為20041120_220041228。

E.升級報告\EP0S3升級報告版本號和任務單號。有的話需要填寫完整

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

L項目手冊把項目手冊里的填寫完整

提交規(guī)范

最初的項目實施

更新目錄：對于最初的項目實施必須提交以下目錄的內容：

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

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

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

?.\D_客戶信息;

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