設(shè)計規(guī)范(JSHINET-SPI-TS-Std-Design)V1.0

1、文件標(biāo)題文檔編號0100-0517-D0100-0517-Designesign當(dāng)前版本1.01.0設(shè)計規(guī)范設(shè)計規(guī)范生效日期2007-03-12007-03-1江蘇海納英華科技股份有限公司 第 1 頁 共 20頁設(shè)計規(guī)范設(shè)計規(guī)范文檔密級：普通文檔狀態(tài)： 草案 正式發(fā)布 正在修訂變更履歷變更履歷序號序號版本版本變更描述變更描述修訂人修訂人/ /日期日期審核審核/ /日期日期批準(zhǔn)批準(zhǔn)/ /日期日期11.0正式發(fā)布周艷2007-03-1劉鵬玉2007-03-1范建進(jìn)2007-03-1234567891011目目 錄錄1 1總總體設(shè)計體設(shè)計規(guī)規(guī)范范 .3 31.11.1說明說明 .3 31.21.2總

2、體設(shè)計書總體設(shè)計書 .3 31.31.3項目開發(fā)約定項目開發(fā)約定 .4 42 2數(shù)據(jù)庫設(shè)計數(shù)據(jù)庫設(shè)計規(guī)規(guī)范范 .43 3界面設(shè)計規(guī)范界面設(shè)計規(guī)范 .6 63.13.1界面設(shè)計原則界面設(shè)計原則 .6 63.23.2界面資源設(shè)計界面資源設(shè)計 .8 83.33.3界面容錯性設(shè)計界面容錯性設(shè)計 .13133.43.4界面響應(yīng)設(shè)計界面響應(yīng)設(shè)計 .13133.53.5界界面面術(shù)術(shù)語語設(shè)計設(shè)計 .14144 4模塊設(shè)模塊設(shè)計計規(guī)規(guī)范范 .15154.14.1說明說明 .15154.24.2設(shè)計模設(shè)計模式式 .15154.34.3概要概要/ /詳細(xì)設(shè)詳細(xì)設(shè)計計說說明明書書 .16165 5類設(shè)類設(shè)計計規(guī)規(guī)范范

3、 .18185.15.1說明說明 .18185.5.2 2包包 .18185.35.3接口接口 .18185.45.4類類 .18185.55.5類圖類圖 .18185.65.6協(xié)作圖協(xié)作圖( (序序列列圖圖) ) .19195.75.7活動活動圖圖 .19195.85.8應(yīng)交文檔應(yīng)交文檔 .20201.1.總體設(shè)計規(guī)范總體設(shè)計規(guī)范1.11.1 說明說明【1.1.1】總體設(shè)計可選（因為總體設(shè)計中的很多內(nèi)容已經(jīng)在方案書或者需求分析書中反映） ，一個項目是否需要寫總體設(shè)計在立項時根據(jù)項目類別的不同決定，但其中的接口設(shè)計、通用功能設(shè)計、目錄結(jié)構(gòu)、開發(fā)規(guī)范部分內(nèi)容必須給出（可以給出單獨文檔） ?！?.

4、1.2】總體設(shè)計是回答“系統(tǒng)怎么做”的問題?！?.1.3】總體設(shè)計在系統(tǒng)設(shè)計過程中起著承上啟下的作用，一方面總體設(shè)計是對需求分析的整合，從整個系統(tǒng)的高度描述各子系統(tǒng)或者模塊之間的關(guān)系；另一方面總體設(shè)計給出了系統(tǒng)將采用的環(huán)境（硬件、網(wǎng)絡(luò)、系統(tǒng)軟件） 、系統(tǒng)構(gòu)架、技術(shù)指標(biāo)和擬采用的技術(shù)路線，是下一步模塊設(shè)計中必須考慮的約束條件?！?.1.4】個系統(tǒng)的總體設(shè)計一般只有一份，形成總體設(shè)計書 。1.21.2 總體設(shè)計書總體設(shè)計書【1.2.1】總體設(shè)計書主要包括以下內(nèi)容：系統(tǒng)架構(gòu)網(wǎng)絡(luò)構(gòu)架：用網(wǎng)絡(luò)拓?fù)鋱D的方式描述整個系統(tǒng)的網(wǎng)絡(luò)構(gòu)架（intranet/extranet/internet）和數(shù)據(jù)傳輸?shù)奈锢項l件，

5、說明可能存在的主機和網(wǎng)絡(luò)瓶頸，分析主機和網(wǎng)絡(luò)方面的風(fēng)險；應(yīng)用構(gòu)架：分層描述整個軟件系統(tǒng)的邏輯結(jié)構(gòu)，一般包括系統(tǒng)層、平臺層、業(yè)務(wù)邏輯層、表示層等，各層采用的系統(tǒng)軟件和第三方軟件、平臺依賴性以及開發(fā)技術(shù)；分析軟件系統(tǒng)構(gòu)架方面的風(fēng)險；模塊構(gòu)成：將整個系統(tǒng)劃分成若干個模塊，再由不同的模塊組成不同的子系統(tǒng)，如果系統(tǒng)較小，可以沒有子系統(tǒng)；界面框架設(shè)計：設(shè)計主要界面的原型，一般分成登錄界面、模塊選擇界面、主界面三層。接口設(shè)計外部接口：包括用戶界面、軟件接口與硬件接口；內(nèi)部接口（模塊之間的接口）：描述模塊之間調(diào)用的具體實現(xiàn)方法，給出模塊之間調(diào)用的接口以及應(yīng)該注意的各種約束和規(guī)則，如果兩兩模塊之間調(diào)用的方法基本

6、類似，可以舉一個實際的例子加以說明，其他接口類似；接口設(shè)計難以用某一種特定的圖形表示，可以用UML 構(gòu)件圖結(jié)合表格的方式描述，參見“附 6” ；數(shù)據(jù)接口：描述子系統(tǒng)之間或者模塊之間的數(shù)據(jù)流和調(diào)用關(guān)系，可以視情況用一個或者一組圖進(jìn)行描述，建議采用 UML 的方式表示，參見“附 13” ；數(shù)據(jù)結(jié)構(gòu)設(shè)計邏輯結(jié)構(gòu)設(shè)計：應(yīng)用模塊的邏輯架構(gòu)；物理結(jié)構(gòu)設(shè)計：包括系統(tǒng)環(huán)境、數(shù)據(jù)庫設(shè)計規(guī)范、數(shù)據(jù)庫安全性設(shè)計、優(yōu)化策略、管理和維護(hù)等內(nèi)容，也可以提交單獨文檔；數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系：在程序設(shè)計時需要注意的問題。開發(fā)規(guī)范通用功能設(shè)計：包括系統(tǒng)中可能會用到的通用組件、通用類、通用數(shù)據(jù)庫對象、通用界面框架等等及其詳細(xì)說明，

7、能夠采用公司組件庫的盡量采用組件，并且對哪些地方怎樣使用公司的哪些組件進(jìn)行明確說明；開發(fā)約定：制定項目開發(fā)過程中的各類約定和規(guī)范，在本規(guī)范的基礎(chǔ)上根據(jù)項目的實際情況進(jìn)行擴展和補充，可以單獨成文項目開發(fā)約定 ，參見“附 14” ；技術(shù)架構(gòu)：在公司統(tǒng)一技術(shù)架構(gòu)的基礎(chǔ)上根據(jù)項目實際情況進(jìn)行擴展，但總體上必須和公司的技術(shù)架構(gòu)保持一致，公司統(tǒng)一的技術(shù)架構(gòu)參見“附 22” ；目錄結(jié)構(gòu)：給出整個系統(tǒng)的目錄結(jié)構(gòu)，一般細(xì)化到模塊一級，模塊以下的目錄結(jié)構(gòu)在模塊設(shè)計中描述；目錄規(guī)范參見“附 15” ；配置說明：環(huán)境說明：開發(fā)環(huán)境、運行環(huán)境和測試環(huán)境的詳細(xì)說明（主機、系統(tǒng)軟件、工具包以及版本號） ；配置文件：系統(tǒng)中包

8、含的配置文件以及各個配置文件的具體作用、存放目錄以及維護(hù)方法。風(fēng)險分析： 風(fēng)險識別與評估：首先描述用戶提出的技術(shù)指標(biāo)和性能要求，分析采用當(dāng)前技術(shù)路線時存在的風(fēng)險，給出擬采用的解決方法；風(fēng)險對策：如風(fēng)險管理計劃、風(fēng)險控制策略等。維護(hù)設(shè)計：說明為方便維護(hù)工作的設(shè)施，如維護(hù)模塊等。附錄其他需要項目團隊成員遵守的約定、編碼表、標(biāo)準(zhǔn)化等。1.31.3 項目開發(fā)約定項目開發(fā)約定【1.3.1】項目開發(fā)約定主要包括以下內(nèi)容：項目開發(fā)約定：規(guī)定項目團隊中各種角色之間的分工、職責(zé)和關(guān)系。參見“附 14” ；模塊設(shè)計約定/數(shù)據(jù)庫約定/編程約定：在對應(yīng)規(guī)范的基礎(chǔ)上結(jié)合項目實際情況進(jìn)行擴展；業(yè)務(wù)約定：各類通用的功能、通

9、用業(yè)務(wù)規(guī)則、通用類或處理方法、項目開發(fā)約定等。在總體設(shè)計階段可能難以考慮十分齊全，可以在項目進(jìn)展過程中不斷補充和完善。2.2.數(shù)據(jù)庫設(shè)計規(guī)范數(shù)據(jù)庫設(shè)計規(guī)范【2.1】數(shù)據(jù)庫設(shè)計相對比較復(fù)雜，并且不同的數(shù)據(jù)庫也有很大的差別，難以制定統(tǒng)一的規(guī)范，這里給出公司常用的 Oracle 數(shù)據(jù)庫的推薦規(guī)范，供設(shè)計人員參考，具體可由項目經(jīng)理/開發(fā)經(jīng)理根據(jù)實際情況進(jìn)行擴充和完善?！?.2】數(shù)據(jù)庫設(shè)計的 SQL 語句范例參見附 19?！?.2】取系統(tǒng)時間，統(tǒng)一用數(shù)據(jù)庫時間【范例】select sysdate from dual【2.3】表空間管理應(yīng)該注意以下幾點：用戶表空間、索引表空間、臨時表空間對應(yīng)的數(shù)據(jù)文件分開

10、不同的磁盤存放，以平衡 I/O；用戶表空間和臨時表空間采用 management local 方式管理，提高運算效率；臨時表空間使用關(guān)鍵字 tempfile 創(chuàng)建，提高效率?！?.4】數(shù)據(jù)庫對象（表、列、視圖、存儲過程等等）全部采用英文（可以是能表達(dá)含義的縮寫） ，并采用駝峰命名法?！?.5】五類數(shù)據(jù)庫約束：主鍵(pkprimary key)、外鍵(fkforeign key)、唯一鍵(ukunique key)、非空鍵(nnnot null)和檢查鍵(ckcheck)，非空鍵和檢查鍵可以不進(jìn)行命名，前三者必須進(jìn)行命名，命名采用前綴+表名后半部分的方式，如果出現(xiàn)重復(fù)，用 1，2，3區(qū)別?！痉独?/p>

11、】表名約束名t_funeral_body_infopk_body_infot_ash_block_layerpk_ block_layerfk_block_layer1fk_block_layer2uk_block_layer【說明】由于主鍵和唯一鍵在創(chuàng)建時，Oracle 自動創(chuàng)建唯一索引，考慮數(shù)據(jù)庫性能需將索引表空間和數(shù)據(jù)表空間分開，因此在主鍵和唯一鍵的創(chuàng)建語句中需加上”using index tablespace indx”。【2.6】建議各項目建立統(tǒng)一的數(shù)據(jù)字典表對表（中英文名）和列（中英文名、數(shù)據(jù)類型、數(shù)據(jù)長度）進(jìn)行維護(hù)（也可以采用 comment 關(guān)鍵字存入 Oracle 數(shù)據(jù)庫本身

12、的數(shù)據(jù)字典表） 。將表和列的信息作為記錄保存到表 t_table_dict 和 t_column_dict 中去，以利于界面數(shù)據(jù)庫表和字段的選擇，建議表名和字段名采用大寫?！?.7】為了提高數(shù)據(jù)庫性能，便于管理和備份，不同的產(chǎn)品（模塊）建立不同的數(shù)據(jù)庫用戶，數(shù)據(jù)庫用戶名作為表名的前綴。【范例】辦公自動化模塊：oa/oa，表名前綴：t_oa檔案管理模塊：archive/archive，表名前綴：t_archive【2.8】模塊之間的相互調(diào)用通過授權(quán)（推薦）和建同義詞的方式進(jìn)行?！痉独哭k公自動化模塊需要調(diào)用檔案管理模塊 t_archive_paper_file 表，則connect archiv

13、e/archivegrant select on t_archive_paper_file to public;create public synonym t_archive_paper_file for t_archive_paper_file;【2.9】為了實現(xiàn)對編碼表的統(tǒng)一維護(hù)，通用編碼表加上表名前綴：t_code，各模塊專用的編碼表放在各自的用戶下，第二級前綴為_code，編碼至少包括兩個字段(code 和 name)，名字必須一致?！痉独縞reate table t_code_unit(code varchar2(4) constraint pk_code_unit primary

14、 keyusing index tablespace indx,name varchar2(40) not null);【2.10】各模塊的臨時表加上第二級前綴_temp，所有表的備份表（表中所有記錄的完整備份） ，在表名的后面加后綴_bak；【2.11】不需要在界面上出現(xiàn)的流水號盡量采用序列號。【范例】select s_sequence.nextval from dual【2.12】考慮到程序處理的方便性和系統(tǒng)的可移植性，盡量不要采用 CLOB/BLOB 類型的字段，建議采用保存文本文件的方式代替；【2.13】日期類型字段沒有特殊情況必須采用 date 類型，而不要采用 varchar 類型

15、；所有字符類型都用varchar2 表示；【2.14】數(shù)字類型字段統(tǒng)一采用 number 類型，而不要用 integer、long 等類型，能夠確定數(shù)字型長度的盡量寫上；【2.15】當(dāng)一個業(yè)務(wù)表中包含 CLOB/BLOB 類型字段時，需將該字段單獨放在另外一個表中保存，通過主鍵關(guān)聯(lián)；【2.16】一個用戶下的表最好控制在 200 個之內(nèi)，一個表中的字段最好控制在 50 個之內(nèi)。3.3.界面設(shè)計規(guī)范界面設(shè)計規(guī)范3.13.1 界面設(shè)計原則界面設(shè)計原則3.1.1 直觀原則直觀原則【3.1.1.1】界面直觀、對用戶透明：用戶接觸軟件后對界面上對應(yīng)的功能一目了然、不需要多少培訓(xùn)就可以方便使用本應(yīng)用系統(tǒng)，網(wǎng)

16、站內(nèi)容必須是容易找。【3.1.1.2】一般來說，超過 3 級鏈接用戶尋找起來就有些困難了，界面層次盡量控制在兩級之內(nèi)。【3.1.1.3】用戶界面應(yīng)當(dāng)由用戶來控制應(yīng)用如何工作、如何響應(yīng)，而不是由開發(fā)者按自己的意愿把操作流程強加給用戶?！?.1.1.4】界面設(shè)計必須經(jīng)過確認(rèn)才能完成?！?.1.1.5】界面上的語言盡量通俗易懂，詳細(xì)設(shè)計請參考后面“界面術(shù)語規(guī)范” 。3.1.2 一致性原則一致性原則【3.1.2.1】在界面設(shè)計中應(yīng)該保持界面的一致性?！?.1.2.2】一致性既包括使用標(biāo)準(zhǔn)的控件，也指使用相同的信息表現(xiàn)方法，如在字體、標(biāo)簽風(fēng)格、顏色、術(shù)語、顯示錯誤信息等方面確保一致。【3.1.2.3】公

17、司的系列產(chǎn)品要保持一致的界面風(fēng)格，背景色、字體、菜單排列方式、圖標(biāo)、安裝過程、按鈕用語等應(yīng)該大體一致：統(tǒng)一的對齊方法：左對齊：一般文字、單個數(shù)字、日期等右對齊：數(shù)字、時間、日期加時間。 統(tǒng)一的字體和顏色：中文：FontName = “宋體” ，F(xiàn)ontSize = 9；英文：FontName = “MS Sans Serif ”，F(xiàn)ontSize = 10；顯示的缺省顏色為黑色；極為重要的提示信息的顯示可采用紅色（需經(jīng)項目負(fù)責(zé)人批準(zhǔn)） ；同一窗口中不要用超過三種顏色；其他特殊字體（包括粗體，斜體和下劃線）和顏色的選用需經(jīng)項目負(fù)責(zé)人批準(zhǔn)。底色缺省采用灰色；統(tǒng)一的控件樣式；統(tǒng)一的界面布局方式；統(tǒng)一

18、的圖標(biāo)。3.1.3 合理化原則合理化原則【3.1.3.1】在一個窗口內(nèi)部所有控件的布局和信息組織的合理化原則就是：使用戶的工作量減小，工作效率提高。如：如何才能讓用戶用最少的步驟，完成一項操作?！?.1.3.2】合理化原則需要注意以下幾點：在一個窗口中按 tab 鍵，移動聚焦的順序不能雜亂無章，tab 的順序是先從上至下，再從左至右；一屏中首先應(yīng)輸入的和重要信息的控件在 tab 順序中應(yīng)當(dāng)靠前，位置也應(yīng)放在窗口上較醒目的位置；錯誤使用容易引起界面退出或關(guān)閉的按鈕不應(yīng)該放在易點位置。橫排開頭或最后與豎排最后為易點位置；對可能造成數(shù)據(jù)無法恢復(fù)的操作必須提供確認(rèn)信息，給用戶放棄選擇的機會；非法的輸入

19、或操作應(yīng)有足夠的提示說明；對運行過程中出現(xiàn)問題而引起錯誤的地方要有提示，讓用戶明白錯誤出處，避免形成無限期的等待；提示、警告、或錯誤說明應(yīng)該清楚、明了、恰當(dāng)。 3.1.4 鼠標(biāo)鍵盤對應(yīng)原則鼠標(biāo)鍵盤對應(yīng)原則【3.1.4.1】應(yīng)遵循的是“可不用鼠標(biāo)”的原則：應(yīng)用中的功能只用鍵盤也應(yīng)當(dāng)可以完成，即設(shè)計的應(yīng)用中還應(yīng)加入一些必要的按鈕和菜單項。3.1.5 美觀與協(xié)調(diào)性原則美觀與協(xié)調(diào)性原則【3.1.5.1】界面設(shè)計中必須突出美觀與協(xié)調(diào)性，雖然每一個人對美觀的理解不一樣，但一些通用的規(guī)范性原則是可以借鑒的。例如：用符號突出特別重要的內(nèi)容，不要過多，保持頁面的簡潔；布局界面元素（WEB 界面是指 HTML 元

20、素）后界面不應(yīng)有很大的空缺位置；字體的大小要與界面的大小比例協(xié)調(diào)，通常使用的字體中宋體 9-12 較為美觀，很少使用超過 12號的字體；前景與背景色搭配合理協(xié)調(diào)，反差不宜太大，最好少用深色，如大紅、大綠等。常用色考慮使用 Windows 界面色調(diào)；如果使用其他顏色，主色要柔和，具有親和力與磁力，堅決杜絕刺目的顏色；大型系統(tǒng)常用的主色有“#E1E1E1” 、 “#EFEFEF” 、 “#C0C0C0”等；界面風(fēng)格要保持一致，字的大小、顏色、字體要相同，除非是需要藝術(shù)處理或有特殊要求的地方；如果窗體支持最小化和最大化或放大時，窗體上的界面元素也要隨著窗體而縮放；切忌只放大窗體而忽略界面元素的縮放；

21、對于含有按鈕的界面一般不應(yīng)該支持縮放，即右上角只有關(guān)閉功能；通常父窗體支持縮放時，子窗體沒有必要縮放；如果能給用戶提供自定義界面風(fēng)格則更好，由用戶自己選擇顏色、字體等。3.1.6 舒適性原則舒適性原則【3.1.6.1】界面舒適性設(shè)計，就是使用戶可以更加舒適地工作。主要體現(xiàn)為色彩：紅色：熱烈，刺眼，易產(chǎn)生焦慮心情。藍(lán)色：平靜，科技，舒適。明色：干凈，明亮，但對眼睛較多刺激，長時間工作易引起疲勞。暗色：安靜，大氣，對眼睛較少刺激。3.23.2 界面資源設(shè)計界面資源設(shè)計3.2.1 啟動封面設(shè)計啟動封面設(shè)計【3.2.1.1】應(yīng)使軟件啟動封面最終為高清晰度的圖像，如軟件啟動封面需在不同的平臺、操作系統(tǒng)上

22、使用將考慮轉(zhuǎn)換不同的格式，并且對選用的色彩不宜超過 256 色?！?.2.1.2】軟件啟動封面大小多為主流顯示器分辨率的 1/6 大。如果是系列軟件將考慮整體設(shè)計的統(tǒng)一和延續(xù)性?！?.2.1.3】軟件啟動封面的上面應(yīng)該醒目的標(biāo)注制作或支持的公司標(biāo)志、產(chǎn)品商標(biāo)，軟件名稱，版本號，網(wǎng)址，版權(quán)聲明，序列號等信息，以樹立軟件形象，方便使用者或購買者在軟件啟動的時候得到提示?！?.2.1.4】插圖宜使用具有獨立版權(quán)的，象征性強的，識別性高的，視覺傳達(dá)效果好的圖形，若使用攝影也應(yīng)該進(jìn)行數(shù)位處理，以形成該軟件的個性化特征?！?.2.1.5】盡量少用滾動條，除非信息量很大。3.2.2 界面框架設(shè)計界面框架設(shè)計

23、【3.2.2.1】合理布置控件位置，一定要整齊?！?.2.2.2】除主窗口、瀏覽、報表預(yù)覽等窗口外，一般窗口不要太大?！?.2.2.3】主窗口不能有太多的功能控件，需要進(jìn)行合理分類，避免控件的羅列和堆積?！?.2.2.4】窗口盡量少（關(guān)于窗口、消息框、輸入對話框等除外） ，將相關(guān)信息最好放在一個窗口。【3.2.2.5】窗口中信息量大可采用 Tab 頁方式，信息量小采用 Group 方式。【3.2.2.6】窗口布局要合理，不宜過于密集，也不能過于空曠，合理的利用空間，左右邊距必須相等?！?.2.2.7】窗體位置：屏幕正中（由代碼控制） ?！?.2.2.8】具有返回值的窗口，最好設(shè)計成對話框模式（

24、模式窗口） 。【3.2.2.9】模式窗口在一個應(yīng)用中定義為統(tǒng)一規(guī)格，建議以下三種規(guī)格：_LargeDialogType：（width*0.73,height*0.75）主要用于信息辦理操作，功能較多的界面；_xMediumDialogType：（width*0.58,height*0.58）主要用于比較多的信息錄入、保存、修改、修改等單一操作界面；_MediumDialogType：（width*0.48,height*0.52）主要用于少量的信息錄入、保存、修改等單一操作界面；_SmallDialogType：（width*0.38,height*0.39）主要用于消息顯示界面。其中：wid

25、th、height 是指屏幕的寬度和高度，適應(yīng)各種分辨率的變化。【3.2.2.10】窗口中完成同一功能或任務(wù)的元素放在集中位置，減少鼠標(biāo)移動的距離。【3.2.2.11】按功能將界面劃分局域塊，用 Frame 框括起來，并要有功能說明或標(biāo)題?！?.2.2.12】界面要支持鍵盤自動瀏覽按鈕功能，即按 Tab 鍵的自動切換功能；首先應(yīng)輸入的和重要信息的控件在 Tab 順序中應(yīng)當(dāng)靠前，位置也應(yīng)放在窗口上較醒目的位置。【3.2.2.13】同一界面上的控件數(shù)最好不要超過 10 個，多于 10 個時可以考慮使用分頁界面顯示?！?.2.2.14】專業(yè)性強的軟件要使用相關(guān)的專業(yè)術(shù)語，通用性界面則提倡使用通用性詞

26、眼?！?.2.2.15】父窗體或主窗體的中心位置應(yīng)該在對角線焦點附近；子窗體位置應(yīng)該在主窗體的左上角或正中；多個子窗體彈出時應(yīng)該依次向右下方偏移，以顯示窗體出標(biāo)題為宜?！?.2.2.16】窗體長寬接近黃金點比例，切忌長寬比例失調(diào)、或?qū)挾瘸^長度。寬度和長度的比例是B：A=A：（A+B） ，即 1:1.618 或 0.618:1?！?.2.2.17】右鍵快捷菜單采用與菜單相同的準(zhǔn)則。【3.2.2.18】界面框架的設(shè)計必須能夠適應(yīng)用戶的分辨率變化（至少應(yīng)該實現(xiàn) 1024*768 和 800*600 兩種分辨率） ?！?.2.2.19】任何時候，不要忘記網(wǎng)頁的標(biāo)題是否被正確設(shè)置。3.2.3 界面導(dǎo)航

27、設(shè)計界面導(dǎo)航設(shè)計【3.2.3.1】界面導(dǎo)航一定要清晰?！?.2.3.2】功能應(yīng)容易發(fā)現(xiàn)，便于理解，給一些友好的提示?！?.2.3.3】所有的超鏈接應(yīng)清晰無誤地向讀者標(biāo)識出來，所有導(dǎo)航性質(zhì)的設(shè)置，像圖像按鈕，都要有清晰的標(biāo)識，讓人看得明白。【3.2.3.4】文本鏈接一定要和頁面的其他文字有所區(qū)分，給讀者清楚的導(dǎo)向?！?.2.3.5】讀者進(jìn)入目的頁的點擊次數(shù)，不能超過三次。3.2.4 按鈕設(shè)計按鈕設(shè)計【3.2.4.1】軟件按鈕設(shè)計應(yīng)該具有交互性，即應(yīng)該有 3 到 6 種狀態(tài)效果：點擊時狀態(tài)；鼠標(biāo)放在上面但未點擊的狀態(tài)；點擊前鼠標(biāo)未放在上面時的狀態(tài)；點擊后鼠標(biāo)未放在上面時的狀態(tài)；不能點擊時狀態(tài)；獨立

28、自動變化的狀態(tài)。【3.2.4.2】按鈕應(yīng)具備簡潔的圖示效果，應(yīng)能夠讓使用者產(chǎn)生功能關(guān)聯(lián)反應(yīng)?！?.2.4.3】完成相同或相近功能的按鈕集中歸類放置，或用 Frame 框起來，群組內(nèi)按鈕應(yīng)該風(fēng)格統(tǒng)一，功能差異大的按鈕應(yīng)該有所區(qū)別?！?.2.4.4】常用按鈕要支持快捷方式?！?.2.4.5】一個窗體中不允許有兩個相同標(biāo)題的按鈕。 【3.2.4.6】默認(rèn)按鈕要支持 Enter 及選操作，即按 Enter 后自動執(zhí)行默認(rèn)按鈕對應(yīng)操作。 【3.2.4.7】可寫控件檢測到非法輸入后應(yīng)給出說明并能自動獲得焦點。 【3.2.4.8】重要的命令按鈕與使用較頻繁的按鈕要放在界面上注目的位置。 【3.2.4.9】與

29、正在進(jìn)行的操作無關(guān)的按鈕應(yīng)該加以屏蔽（用灰色顯示，沒法使用該按鈕） 。 【3.2.4.10】按鈕大小基本相近，忌用太長的名稱，免得占用過多的界面位置。按鈕的標(biāo)準(zhǔn)規(guī)格為：80px23px。 （參考組件庫的按鈕規(guī)格標(biāo)準(zhǔn)）【3.2.4.11】按鈕的排列要與界面的大小和空間要協(xié)調(diào)。如果按鈕過多，可以采用菜單方式顯示不常操作的按鈕。 【3.2.4.12】避免空曠的界面上放置很大的按鈕。 【3.2.4.13】無任何鏈接內(nèi)容的不做成按鈕的形式。3.2.5 選擇框設(shè)計選擇框設(shè)計【3.2.5.1】選擇框包括復(fù)選框、單選框和選項框等?！?.2.5.2】在 WEB 應(yīng)用，傳統(tǒng)的 select 框無法用 DIV 蓋住

30、，因此建議采用組件庫提供的 select 組件。 【3.2.5.3】復(fù)選框和選項框按選擇幾率的高底而先后排列。 【3.2.5.4】復(fù)選框和選項框要有默認(rèn)選項，并支持 Tab 選擇。 【3.2.5.5】選項數(shù)相同時多用選項框而不用下拉列表框。 【3.2.5.6】界面空間較小時使用下拉框而不用選項框。 【3.2.5.7】選項數(shù)較少時使用選項框，相反使用下拉列表框。 3.2.6 面板設(shè)計面板設(shè)計【3.2.6.1】軟件面板設(shè)計應(yīng)該具有縮放功能?！?.2.6.2】面板應(yīng)該對功能區(qū)間劃分清晰，應(yīng)該和對話框，彈出框等風(fēng)格匹配，盡量節(jié)省空間，切換方便。3.2.7 菜單設(shè)計菜單設(shè)計【3.2.7.1】菜單設(shè)計一般

31、有選中狀態(tài)和未選中狀態(tài)，左邊應(yīng)為名稱，右邊應(yīng)為快捷鍵，如果有下級菜單應(yīng)該有下級箭頭符號。【3.2.7.2】不同功能區(qū)間應(yīng)該用線條分隔?！?.2.7.3】常用菜單要有命令快捷方式。 【3.2.7.4】菜單通常采用“常用-主要-次要-工具-幫助”的位置排列，符合流行的 Windows 風(fēng)格。 【3.2.7.5】主菜單數(shù)目不應(yīng)太多，最好為單排布置?！?.2.7.6】主菜單的寬度要接近，字?jǐn)?shù)不應(yīng)多于四個，每個菜單的字?jǐn)?shù)能相同最好。 【3.2.7.7】一組菜單的使用有先后要求或有向?qū)ё饔脮r，應(yīng)該按先后次序排列。 【3.2.7.8】沒有順序要求的菜單項按使用頻率和重要性排列，常用的放在開頭，不常用的靠后放

32、置；重要的放在開頭，次要的放在后邊。 【3.2.7.9】菜單前的圖標(biāo)能直觀的代表要完成的操作，圖標(biāo)不宜太大，與字高保持一直最好。 【3.2.7.10】菜單深度一般要求最多控制在三層以內(nèi)?！?.2.7.11】如果菜單選項較多，應(yīng)該采用加長菜單的長度而減少深度的原則排列。 【3.2.7.12】對與進(jìn)行的操作無關(guān)的菜單要用屏蔽的方式加以處理，如果采用動態(tài)加載方式（即只有需要的菜單才顯示）最好。【3.2.7.13】盡量不要使用右建菜單。如果要使用，也必須存在顯式的操作方式與之對應(yīng)，這樣符合界面的“所見及所用”的原則。3.2.8 工具欄設(shè)計工具欄設(shè)計【3.2.8.1】工具欄要求可以根據(jù)用戶的要求自己選擇

33、定制。 【3.2.8.2】相同或相近功能的工具欄放在一起。 【3.2.8.3】工具欄中的每一個按鈕要有及時提示信息。 【3.2.8.4】一條工具欄的長度最長不能超出屏幕寬度。 【3.2.8.5】工具欄的圖標(biāo)能直觀的代表要完成的操作。 【3.2.8.6】系統(tǒng)常用的工具欄設(shè)置默認(rèn)放置位置。 【3.2.8.7】工具條一般比菜單要寬，但不要寬的太多，否則看起來很不協(xié)調(diào)。 【3.2.8.8】工具欄要具有可增減性，由用戶自己根據(jù)需求定制。 【3.2.8.9】工具欄的默認(rèn)總寬度不要超過屏幕寬度的 1/5。3.2.9 標(biāo)簽設(shè)計標(biāo)簽設(shè)計【3.2.9.1】標(biāo)簽設(shè)計應(yīng)該注意轉(zhuǎn)角部分的變化，狀態(tài)可參考按鈕。【3.2.

34、9.2】屏幕上顯示的頁面所對應(yīng)的標(biāo)簽應(yīng)該相應(yīng)變成灰色、突出顯示或以其它方式表示出來。3.2.10 圖標(biāo)設(shè)計圖標(biāo)設(shè)計【3.2.10.1】欄目如果采用圖標(biāo)，下面應(yīng)附有文字說明，以避免圖像表達(dá)不清；【3.2.10.2】圖標(biāo)色彩的一致性符合下列條件中的任何一個條件均可：同一色彩；同一色系；同一色板；【3.2.10.3】圖標(biāo)形式的一致性符合下列條件中的第一個以及其它任何一個條件均可：尺寸一致；內(nèi)容中包含有同一元素；采用相同的外圍形狀；【3.2.10.4】圖標(biāo)設(shè)計色彩不宜超過 64 色，大小為 1616、2424、3232、4848 四種；【3.2.10.5】圖標(biāo)的設(shè)計應(yīng)該清楚地表達(dá)圖標(biāo)的含義，強調(diào)可讀性

35、和完整性；【3.2.10.6】可以考慮將圖標(biāo)分組，更確切地表達(dá)圖標(biāo)的含義；【3.2.10.7】在圖標(biāo)中增加提示文本；【3.2.10.8】圖標(biāo)上的文字描述和拼音描述（或英文描述）要保持一致，拼音描述最好按詞組分開。3.2.11 滾動條設(shè)計滾動條設(shè)計【3.2.11.1】滾動條主要是為了對區(qū)域性空間的固定大小中內(nèi)容量的變換進(jìn)行設(shè)計，應(yīng)該有上下箭頭，滾動標(biāo)等，有些還有翻頁標(biāo)?！?.2.11.2】滾動條的長度要根據(jù)顯示信息的長度或?qū)挾饶芗皶r變換，以利于用戶了解顯示信息的位置和百分比。 3.2.12 狀態(tài)欄設(shè)計狀態(tài)欄設(shè)計【3.2.12.1】狀態(tài)欄是為了對軟件當(dāng)前狀態(tài)的顯示和提示?！?.2.12.2】狀態(tài)條

36、要能顯示用戶切實需要的信息，常用的有：目前的操作、系統(tǒng)狀態(tài)、用戶位置、用戶信息、提示信息、錯誤信息等，如果某一操作需要的時間較長，還應(yīng)該顯示進(jìn)度條和進(jìn)程提示。 【3.2.12.3】狀態(tài)條的高度以放置五號字為宜，滾動條的寬度比狀態(tài)條的略窄。 【3.2.12.4】狀態(tài)條中通常使用 5 號字體。 3.2.13 幫助設(shè)計幫助設(shè)計【3.2.13.1】常用的幫助設(shè)施有兩種：集成的和附加的。集成的幫助設(shè)施：一開始就是設(shè)計在軟件中的，它與語境有關(guān)，用戶可以直接選擇與所要執(zhí)行操作相關(guān)的主題。通過集成幫助設(shè)施可以縮短用戶獲得幫助的時間，增加界面的友好性；附加的幫助設(shè)施：在系統(tǒng)建好以后再加進(jìn)去的。通常是一種查詢能力

37、比較弱的聯(lián)機幫助。【3.2.13.2】用戶可以通過幫助菜單、F1 鍵和幫助按鈕（如果有的話）多種方式訪問幫助?！?.2.13.3】幫助文檔中的性能介紹與說明要與系統(tǒng)性能配套一致。 【3.2.13.4】打包新系統(tǒng)時，對作了修改的地方在幫助文檔中要做相應(yīng)的修改。 【3.2.13.5】操作時要提供及時調(diào)用系統(tǒng)幫助的功能，常用 F1。 【3.2.13.6】在界面上調(diào)用幫助時應(yīng)該能夠及時定位到與該操作相對的幫助位置。也就是說幫助要有即時針對性。【3.2.13.7】最好提供目前流行的聯(lián)機幫助格式或 HTML 幫助格式?！?.2.13.8】用戶可以用關(guān)鍵詞在幫助索引中搜索所要的幫助，當(dāng)然也應(yīng)該提供幫助主題詞

38、?！?.2.13.9】如果沒有提供書面的幫助文檔的話，最好有打印幫助的功能?！?.2.13.10】在幫助中應(yīng)該提供我們的技術(shù)支持方式，一旦用戶難以自己解決可以方便的尋求新的幫助方式?！?.2.13.11】微幫助提供：由狀態(tài)欄提供，或控件上的提示文本。3.2.14 快捷鍵設(shè)計快捷鍵設(shè)計【3.2.14.1】在菜單項中使用快捷鍵可以讓使用鍵盤的用戶操作得更快一些，在 Windows 及其應(yīng)用軟件中快捷鍵的使用大多是一致的。產(chǎn)品中應(yīng)用的快捷鍵在各個配置項上語義上必須與主流操作系統(tǒng)保持一致?！?.2.14.2】常見快捷鍵設(shè)計有：面向事務(wù)的Ctrl-D刪除 Ctrl-F尋找 Ctrl-I插入 Ctrl-N

39、新記錄 Ctrl-S保存 查詢/列表Ctrl-R，Ctrl-G定位Ctrl-Tab下一分頁窗口或反序瀏覽同一界面元素 編輯 Ctrl-A全選Ctrl-C 拷貝Ctrl-V 粘貼Ctrl-X 剪切Ctrl-Z撤消操作Ctrl-Y恢復(fù)操作 文件操作 Ctrl-P打印Ctrl-W關(guān)閉系統(tǒng)菜單Alt-A文件Alt-E編輯Alt-T工具AltW窗口AltH幫助MS Windows 保留鍵: Ctrl-Tab 下一窗口 Ctrl-Esc 任務(wù)列表 Ctrl-F4 關(guān)閉窗口 Alt-F4 結(jié)束應(yīng)用 Alt-Tab 下一應(yīng)用 Enter 缺省按鈕/確認(rèn)操作 Esc 取消按鈕/取消操作 Shift-F1 上下文

40、相關(guān)幫助 其它快捷鍵其它快捷鍵使用漢語拼音的開頭字母，不常用的可以沒有快捷鍵。3.33.3 界面容錯性設(shè)計界面容錯性設(shè)計【3.3.1】開發(fā)者應(yīng)當(dāng)盡量周全地考慮到各種可能發(fā)生的問題，使出錯的可能降至最小。【3.3.2】界面容錯性設(shè)計最重要的是排除可能會使應(yīng)用非正常中止的錯誤。【3.3.3】應(yīng)當(dāng)注意盡可能避免用戶無意錄入無效的數(shù)據(jù)?！?.3.4】采用相關(guān)控件（或界面元素）限制用戶輸入值的種類。【3.3.5】當(dāng)用戶作出選擇的可能性只有兩個時，可以采用單選框?！?.3.6】當(dāng)選擇的可能再多一些時，可以采用復(fù)選框，每一種選擇都是有效的，用戶不可能輸入任何一種無效的選擇?！?.3.7】當(dāng)選項特別多時，可以

41、采用列表框，下拉式列表框?！?.3.8】在一個應(yīng)用系統(tǒng)中，開發(fā)者應(yīng)當(dāng)避免用戶作出未經(jīng)授權(quán)或沒有意義的操作。【3.3.9】對可能引起致命錯誤或系統(tǒng)出錯的輸入字符或動作要加限制或屏蔽?！?.3.10】對可能發(fā)生嚴(yán)重后果的操作要有補救措施。通過補救措施用戶可以回到原來的正確狀態(tài)。刪除信息時要有確認(rèn)，確認(rèn)后再行刪除。如果刪除文件，在設(shè)計上更要謹(jǐn)慎，千萬不要誤刪?！?.3.11】對一些特殊符號的輸入、與系統(tǒng)使用的符號相沖突的字符等進(jìn)行判斷并阻止用戶輸入該字符。【3.3.12】對錯誤操作最好支持可逆性處理（Undo 操作） ，如取消系列操作?！?.3.13】在輸入有效性字符之前應(yīng)該阻止用戶進(jìn)行只有輸入之后

42、才可進(jìn)行的操作?！?.3.14】對可能造成等待時間較長的操作應(yīng)該提供取消功能?！?.3.15】與系統(tǒng)采用的保留字符沖突的要加以限制?！?.3.16】在讀入用戶所輸入的信息時，根據(jù)需要選擇是否去掉前后空格。有些讀入數(shù)據(jù)庫的字段不支持中間有空格，但用戶切實需要輸入中間空格，這時要在程序中加以處理。【3.3.17】程序處理避免用戶提交兩次?！?.3.18】該用 JS 驗證合法的就要驗證，堅決避免服務(wù)器端進(jìn)行驗證，以免加大服務(wù)器負(fù)擔(dān)，同時，影響網(wǎng)頁反應(yīng)的速度?！?.3.19】編程人員測試程序時要用上界限外值，合法值，下界限外值進(jìn)行測試。在編程時最常出現(xiàn)的錯誤發(fā)生在邊界位置?！?.3.20】跨平臺編譯：

43、Java 在編譯時有個-encoding 選項，通常情況下我們忽略它，使用默認(rèn)的操作系統(tǒng)的編碼方式：Windows 下使用 GBK，而 Linux 下使用 UTF-8，這樣在 Linux 下編譯的程序移植到Windows 下運行就出了問題，反之亦然。3.43.4 界面響應(yīng)設(shè)計界面響應(yīng)設(shè)計【3.4.1】提供反饋有以下幾種技術(shù)手段：動畫變化與進(jìn)度條動畫變化與進(jìn)度條 顯示一個動畫或進(jìn)度條，能夠告訴用戶系統(tǒng)正在進(jìn)行一個費時的操作。微幫助微幫助 它是 MDI（多文檔界面）框下面的狀態(tài)條中的文字。窗口底部的微幫助一般有兩個作用：一是在用戶選擇菜單項或其他窗口控件時，顯示更多的文字信息來解釋或提示用戶所要進(jìn)

44、行的操作是什么，另一個用途是系統(tǒng)在處理進(jìn)程中顯示正在進(jìn)行的工作狀態(tài)，以使用戶了解系統(tǒng)的處理進(jìn)度，從而免去死機的擔(dān)心。工具條的幫助工具條的幫助當(dāng)鼠標(biāo)停留在某一個工具欄上時，會出現(xiàn)一個彈出式信息框，缺省顯示的是工具欄文字。聲音提示聲音提示在用戶可能進(jìn)行破壞性操作時，用聲音及時提出警告是必要的，但不能濫用?！?.4.2】在系統(tǒng)響應(yīng)時間上堅持如下原則： 響應(yīng)時間長度響應(yīng)時間長度界面設(shè)計界面設(shè)計0-10 秒鼠標(biāo)顯示成為沙漏10 到 18 秒由微幫助來顯示處理進(jìn)度18 秒 以 上顯示處理窗口，或顯示進(jìn)度條需要長時間的處理完成時應(yīng)給予完成警告信息，如發(fā)出一個提示警告聲如 beep(1)，這樣用戶不必總看著屏

45、幕響應(yīng)時間的易變性響應(yīng)時間的易變性界面設(shè)計界面設(shè)計用戶感覺不到不考慮用戶稍微感覺到由微幫助提供易變性說明容易性大而且時間絕對差別大顯示易變性提示3.53.5 界面術(shù)語設(shè)計界面術(shù)語設(shè)計【3.5.1】信息不能含糊、混亂?！?.5.2】不能技術(shù)性太強。【3.5.3】不能出現(xiàn)錯字、別字，行業(yè)、專業(yè)術(shù)語要仔細(xì)核對?！?.5.4】不要使用不通順的詞句，不要自造詞語?！?.5.5】不要使用難以理解的詞句，表達(dá)要通俗易懂，可以適當(dāng)增加提示信息?！?.5.6】不要使用包含與公司或用戶不相關(guān)的信息（比如 Oracle）的圖片?！?.5.7】前后需要一致，要注意信息點描述的一致性?！痉独勘热绲卿洠阂炊加谩懊艽a”

46、 ，要么都用“口令”一詞。【3.5.8】禁止中英文混用，如無特殊需要，不要中英文混用。【3.5.9】“確定”與“保存” 、 “取消”與“關(guān)閉”的區(qū)別【說明】“確定”是指：接受輸入的數(shù)據(jù)或顯示的響應(yīng)信息，關(guān)掉窗口；“保存”是指：保存數(shù)據(jù)，停留在當(dāng)前窗口；“取消”是指：不接受輸入的信息，關(guān)掉窗口；“關(guān)閉”是指：結(jié)束當(dāng)前的任務(wù)，讓程序繼續(xù)進(jìn)行；關(guān)掉窗口。從上面四個含義的比較來看，在對話框中， “確定”與“取消”成對出現(xiàn)， “保存”與“關(guān)閉”成對出現(xiàn)，不能混在一塊使用。【3.5.10】常用提示信息要求：【范例】單擊“保存”按鈕后不論成功與否均給出提示信息；（1）成功提示信息：“保存成功”（2）不成功提

47、示信息：錯誤描述+“重新保存?”（3）不成功提示信息：錯誤描述單擊“刪除”按鈕后需給出提示信息：（1）“確定要刪除”+刪除的內(nèi)容+“？”（2） 不能刪除的原因+“不能刪除”數(shù)據(jù)輸入錯誤：（1）格式錯誤：“*格式錯誤：正確格式為”+格式描述（2）數(shù)值錯誤：a 輸入數(shù)值逾越上下限：“*不應(yīng)超過（大于） ”+上限值；“*不應(yīng)低于（小于） ”+下限值b 輸入非法數(shù)值：c 必填數(shù)據(jù)項未填：必填數(shù)據(jù)項名+“必須輸入”d 數(shù)據(jù)之間的關(guān)聯(lián)錯誤：數(shù)據(jù)庫連接失?。哄e誤描述+“請聯(lián)系統(tǒng)管理員” 。網(wǎng)絡(luò)連接失?。哄e誤描述+“請稍后再試” ；錯誤描述+“請聯(lián)系統(tǒng)管理員” 。4.4.模塊設(shè)計規(guī)范模塊設(shè)計規(guī)范4.14.1

48、說明說明【4.1.1】模塊設(shè)計按照模塊進(jìn)行，如果模塊太大可以將模塊分成若干個子模塊分別設(shè)計?！?.1.2】建議在設(shè)計之前首先進(jìn)行標(biāo)準(zhǔn)化工作，建立業(yè)務(wù)信息點數(shù)據(jù)字典和通用編碼表的清單，供各模塊調(diào)用，并分析各模塊（節(jié)點）之間的調(diào)用關(guān)系，避免類的重復(fù)設(shè)計和數(shù)據(jù)庫基表的重復(fù)定義，分析的文檔可作為模塊設(shè)計的附錄?！?.1.3】具體地說，三層架構(gòu)（表示層、業(yè)務(wù)邏輯層和數(shù)據(jù)層）完整的模塊設(shè)計應(yīng)包括功能設(shè)計、表示層設(shè)計、接口設(shè)計、類設(shè)計、基表設(shè)計、數(shù)據(jù)庫設(shè)計、附錄七部分內(nèi)容（如果除了這七部分還不能描述清楚，可以根據(jù)需要增加，比如狀態(tài)設(shè)計、流程設(shè)計等） ?！?.1.4】由于設(shè)計的工作量較大，可以根據(jù)項目情況將模

49、塊設(shè)計劃分成概要設(shè)計、詳細(xì)設(shè)計、類設(shè)計等幾部分，分別由不同崗位的角色完成，但對于一個項目來說，這七部分內(nèi)容應(yīng)該完整。4.24.2 設(shè)計模式設(shè)計模式4.2.1 說明說明【4.2.1.1】按照軟件工程對于面向?qū)ο筌浖O(shè)計過程的定義，軟件的設(shè)計應(yīng)包括以下三個階段：概念設(shè)計：了解用戶的工作，確定用戶的需求，建立概念模型，主要責(zé)任人是項目經(jīng)理，大致對應(yīng)需求分析；邏輯設(shè)計：描述解決方案、定義用戶接口、確定用戶界面、設(shè)計邏輯數(shù)據(jù)庫，主要責(zé)任人是開發(fā)經(jīng)理或系統(tǒng)分析員，應(yīng)該對應(yīng)概要設(shè)計；物理設(shè)計：定義組件，詳細(xì)描述類的屬性和方法，設(shè)計物理數(shù)據(jù)庫，主要責(zé)任人是開發(fā)人員，應(yīng)該對應(yīng)詳細(xì)設(shè)計。邏輯設(shè)計和物理設(shè)計統(tǒng)稱為模

50、塊設(shè)計?！?.2.1.2】結(jié)合我們公司的實際情況，由于各個項目的開發(fā)周期、項目價值、客戶要求不盡相同，可以對模塊設(shè)計的模式進(jìn)行劃分，在保證文檔規(guī)范的基礎(chǔ)上適應(yīng)不同項目組的需要。4.2.1.1 橫向開發(fā)模式橫向開發(fā)模式【4.2.1.1.1】定義：根據(jù)項目小組的角色劃分任務(wù)，各個角色各司其職，設(shè)計集中在少數(shù)系統(tǒng)分析員手中完成的開發(fā)模式；【4.2.1.1.2】適用范圍：所有項目，也是目前公司最主要和推薦的開發(fā)模式；【4.2.1.1.3】設(shè)計劃分：設(shè)計名稱設(shè)計名稱設(shè)計內(nèi)容設(shè)計內(nèi)容責(zé)任者責(zé)任者詳細(xì)設(shè)計功能設(shè)計、表示層設(shè)計、接口設(shè)計、基表設(shè)計、數(shù)據(jù)庫設(shè)計系統(tǒng)分析員類設(shè)計類設(shè)計系統(tǒng)分析員/開發(fā)工程師說明：由

51、于項目進(jìn)度制約，類設(shè)計可以在開發(fā)完成之后補充（Javadoc 方式） ，但在項目進(jìn)度允許的情況下鼓勵在開發(fā)之前完成類設(shè)計?！?.2.1.1.4】優(yōu)缺點：優(yōu)點：設(shè)計容易控制，設(shè)計質(zhì)量容易保證，項目小組內(nèi)崗位職責(zé)劃分清楚，人員逐漸增加，資源壓力小；缺點：容易造成設(shè)計人員和開發(fā)人員的溝通障礙，設(shè)計缺陷反饋周期長，設(shè)計人員難以做到對開發(fā)人員的持續(xù)跟蹤。4.2.1.2 縱向開發(fā)模式縱向開發(fā)模式【4.2.1.2.1】定義：根據(jù)項目的模塊劃分任務(wù)，由開發(fā)經(jīng)理和系統(tǒng)分析員完成概要設(shè)計，由開發(fā)人員在概要設(shè)計的基礎(chǔ)上進(jìn)行詳細(xì)設(shè)計并完成模塊開發(fā)的開發(fā)模式；【4.2.1.2.2】適用范圍：小型項目、非重點項目、完全采

52、用面向?qū)ο笤O(shè)計的項目；【4.2.1.2.3】設(shè)計劃分：設(shè)計名稱設(shè)計名稱設(shè)計內(nèi)容設(shè)計內(nèi)容責(zé)任者責(zé)任者概要設(shè)計功能設(shè)計、表示層設(shè)計、接口設(shè)計開發(fā)經(jīng)理/系統(tǒng)分析員詳細(xì)設(shè)計類設(shè)計、基表設(shè)計、數(shù)據(jù)庫設(shè)計開發(fā)工程師說明：概要設(shè)計中可以不包括接口設(shè)計。詳細(xì)設(shè)計部分的工作由開發(fā)工程師完成，但職責(zé)屬于系統(tǒng)分析員，由于設(shè)計不全導(dǎo)致項目問題，由開發(fā)經(jīng)理/系統(tǒng)分析員承擔(dān)責(zé)任?！?.2.1.2.4】優(yōu)缺點：優(yōu)點：沒有溝通問題，錯誤反饋時間短，開發(fā)效率高；缺點：對于開發(fā)工程師的要求高，開發(fā)工程師既是設(shè)計者又是開發(fā)者，難以保證設(shè)計的質(zhì)量，容易造成功能的大量返工，項目開發(fā)的風(fēng)險較大，開發(fā)經(jīng)理需要加強監(jiān)督力度。4.2.1.3

53、敏捷開發(fā)模式敏捷開發(fā)模式【4.2.1.3.1】定義：敏捷（Agile）開發(fā)模式從極限編程（XP）發(fā)展而來，強調(diào)程序員的職責(zé)在于編程，突出人的創(chuàng)造性，弱化文檔的作用，一切工作以充分調(diào)動程序員的主觀能動性為中心展開的開發(fā)模式；【4.2.1.3.2】適用范圍：開放源碼項目、產(chǎn)品研發(fā)的技術(shù)探索、技術(shù)難題解決等；【4.2.1.3.3】設(shè)計劃分：設(shè)計名稱設(shè)計名稱設(shè)計內(nèi)容設(shè)計內(nèi)容責(zé)任者責(zé)任者詳細(xì)設(shè)計功能設(shè)計、表示層設(shè)計、數(shù)據(jù)庫設(shè)計、類設(shè)計開發(fā)工程師說明：由于在技術(shù)探索過程中，主要強調(diào)的是功能的實現(xiàn)，在功能初步實現(xiàn)之前，可以暫時沒有文檔，但實現(xiàn)之后必須補上詳細(xì)設(shè)計文檔。【4.2.1.3.4】優(yōu)缺點：a)優(yōu)點：

54、充分發(fā)揮程序員的主觀能動性，從局部來看效率很高；b)缺點：適用范圍較窄，不適合應(yīng)用項目開發(fā)。4.4.3 3 概要概要/ /詳細(xì)設(shè)計說明書詳細(xì)設(shè)計說明書【4.3.1】根據(jù)設(shè)計模式的選擇，進(jìn)行設(shè)計內(nèi)容的取舍?！?.3.2】包含完整設(shè)計內(nèi)容的概要/詳細(xì)設(shè)計說明的格式如下：1.功能設(shè)計【描述所設(shè)計模塊的子模塊或節(jié)點所要實現(xiàn)的具體功能、每部分功能包括的核心技術(shù)以及實現(xiàn)方法、設(shè)計的總體思想、開發(fā)時需要注意的問題、設(shè)計中普遍性的約定、主要的算法和規(guī)則、應(yīng)該實現(xiàn)而尚未實現(xiàn)的功能（原因以及折衷方案）等】2.表示層設(shè)計【包括界面設(shè)計、權(quán)限設(shè)計、菜單設(shè)計和界面功能點描述四部分】界面設(shè)計：需要比較完整地畫出界面元素的

55、布局，描述界面之間的調(diào)用關(guān)系，并對界面進(jìn)行分區(qū)描述，建議在界面設(shè)計之前首先完成界面框架原型，確定界面的樣式表，使界面盡可能接近真實界面；界面設(shè)計必須符合界面開發(fā)規(guī)范，參見本文第十部分；權(quán)限設(shè)計：指出模塊或功能點中所包含的權(quán)限，三種類型的權(quán)限（數(shù)據(jù)權(quán)限、對象權(quán)限和崗位權(quán)限）描述的方法有所不同：數(shù)據(jù)權(quán)限：分成兩種情況：實施工作流：不需要具體描述，在工作流平臺中控制；不實施工作流：在每個界面中具體描述，這里只寫上通用的控制方法。對象權(quán)限：指出每個界面是否需要控制對象權(quán)限，崗位的分類（角色）和各個崗位對應(yīng)的對象權(quán)限信息；崗位權(quán)限：需要分析業(yè)務(wù)需求，和實際的崗位職責(zé)對應(yīng)，由于實施對象權(quán)限，這部分描述可以

56、在實施時再予以考慮。如果不需要考慮權(quán)限，可以略過。菜單設(shè)計：菜單對應(yīng)了系統(tǒng)提供給用戶的功能點，項目開發(fā)不一定采用菜單模式，只需說明模塊包含的主要功能點即可；功能點描述：詳細(xì)說明每一界面元素的界面布局、顯示屬性、具體功能、合法性校驗、各種約束等信息，同時也要確定界面對應(yīng)的 JSP 文件名稱以及界面接收的參數(shù)。3.接口設(shè)計【根據(jù)界面逐個描述界面上每種涉及到業(yè)務(wù)邏輯層操作的輸入輸出參數(shù)信息以及操作的處理步驟，用專業(yè)的設(shè)計（開發(fā)）工具來設(shè)計本模塊的接口與屬性，說明函數(shù)功能、輸入?yún)?shù)、輸出參數(shù)、返回值等。接口模板參見“附 16” 】4.類設(shè)計【采用 UML 類圖的方式設(shè)計業(yè)務(wù)邏輯對象的屬性和方法以及業(yè)務(wù)

57、邏輯對象之間的關(guān)系，具體參見類設(shè)計規(guī)范。 】5.基表設(shè)計【包括基表關(guān)系圖（E/R 圖，參見附 17）和基表結(jié)構(gòu)兩部分內(nèi)容，按照基表模板（參照附 18）詳細(xì)描述設(shè)計內(nèi)容中需要的基表結(jié)構(gòu)信息，注意提取公共表和通用編碼表，并對 E-R圖和基表要用簡單的文字進(jìn)行描述。設(shè)計時無法確定程序開發(fā)中可能用到的視圖，但在開發(fā)完成之后需將視圖補充到基表設(shè)計或數(shù)據(jù)庫設(shè)計中。 】6.數(shù)據(jù)庫設(shè)計【其中數(shù)據(jù)庫腳本部分內(nèi)容必須提供，其它部分內(nèi)容可以在總體設(shè)計中統(tǒng)一描述，也可以提交單獨的數(shù)據(jù)庫設(shè)計說明文檔】數(shù)據(jù)庫環(huán)境說明【說明所采用的數(shù)據(jù)庫系統(tǒng)，設(shè)計工具，編程工具等。詳細(xì)配置】數(shù)據(jù)庫命名規(guī)則說明【參見本文“數(shù)據(jù)庫設(shè)計規(guī)范” 】數(shù)據(jù)庫腳本【包括創(chuàng)建基表、視圖、存儲過程、觸發(fā)器、序列號等數(shù)據(jù)庫對象的 SQL 語句，并輸入必要的初始值（用 SQL 語句表示） ，可以不放在模塊設(shè)計文檔中，而用單獨的 SQL文件表示】數(shù)據(jù)庫安全性設(shè)計【如防止用戶直接操作數(shù)據(jù)庫的方法、用戶帳號密碼的加密方法、角色與權(quán)限】數(shù)據(jù)庫優(yōu)化【優(yōu)化方案，提高數(shù)據(jù)庫性能】數(shù)據(jù)庫管理與維護(hù)說明7.附錄【目錄結(jié)構(gòu)，功能設(shè)計中算法和規(guī)則的詳細(xì)描述，程序設(shè)計中應(yīng)注意的特殊業(yè)務(wù)規(guī)則，可以提取的