1. 程式人生 > >Java web 專案技術文件目錄結構

Java web 專案技術文件目錄結構

近期專案比較忙,沒有更新文章,現在到了專案收尾階段,正好在準備技術文件,所以把這個技術文件的目錄和大家共享一下。

下面目錄是我在參考了幾個專案文件後自己總結出來的,每個章節之間不是遞進關係(如四是對三的進一步詳細描述)就是並列關係(如果4.4.1 和 4.4.2),整個目錄內容如下:

[JavaWeb]專案-開發文件
目錄稽核使用-v0.0.1
XXXX科技股份有限公司


目錄
一、引言	3
1.1 目的	3
1.2 範圍	3
1.3 定義關鍵詞	3
1.4 讀者物件	3
1.5 參考資料	3
二、專案結構描述	3
2.1 系統設計	3
2.2 系統關係	3
三、架構設計	3
3.1 架構分析	3
3.2 元件關係	3
四、專案設計	4
4.1 模組設計	4
4.1.1 xxx模組	4
4.1.2 xxx...	4
4.2 角色設計	4
4.2.1 xxx角色	4
4.2.2 xxx...	4
4.3 用例檢視	4
4.3.1 xxx角色使用者	4
4.3.2 xxx...	4
4.4 邏輯檢視	4
4.4.1 xxx功能點	4
4.4.2 xxx...	4
五、持久層設計	4


一、引言
1.1 目的
1.2 範圍
1.3 定義關鍵詞
1.4 讀者物件
1.5 參考資料
二、專案結構描述
【專案綜述,闡述專案預期目標和使用者範圍】
2.1 系統設計
【根據專案預期目標,做系統設計】
2.2 系統關係
【根據系統設計的結果,闡述系統間的關係】
三、架構設計
【根據系統設計的結果和系統間的關係,確定開發使用的架構】
3.1 架構分析
【主要架構元件的分析,闡述使用原因】
3.2 元件關係
【為實現系統功能,闡述元件間的關係】
四、專案設計
4.1 模組設計
【根據專案預期目標,做模組設計】
4.1.1 xxx模組
【根據模組設計結果,闡述每個模組的負責範圍】
4.1.2 xxx...
4.2 角色設計
【根據專案預期目標和使用者範圍,做角色設計】
4.2.1 xxx角色
【根據角色設計結果,闡述每個角色的可使用模組範圍】
4.2.2 xxx...
4.3 用例檢視
4.3.1 xxx角色使用者
【根據角色設計結果,闡述擁有某個角色的使用者在該專案中的操作流程。操作過程中涉及到各個模組的功能點】
4.3.2 xxx...
4.4 邏輯檢視
4.4.1 xxx功能點
【根據使用者操作涉及到的功能點,設計功能點的實現邏輯】
4.4.2 xxx...
五、持久層設計
【根據專案設計的結果,做持久層設計。作為功能點實現的持久層支撐,並支援專案預期目標的完成】