1. 原則與目標
軟件設計中處理問(wèn)題的過(guò)程要保證簡(jiǎn)單、清晰，一個(gè)功能只處理好一個(gè)問(wèn)題，如果處理不好，那么這個(gè)問(wèn)題就是多個(gè)問(wèn)題，從而要設計多個(gè)功能，總體要求：把復雜的事情簡(jiǎn)單化，把簡(jiǎn)單的事情條理化。
軟件設計規范
2. 要求
產(chǎn)出物：
1) 《概要設計說(shuō)明書(shū)》
2) 數據模型
3) 《詳細設計說(shuō)明書(shū)》
3. 數據模型
1) 字段定義、長(cháng)度、類(lèi)型、命名繼承《數據庫設計規范》；
2) 規范化與反規范化：
綜合考慮范式要求與系統實(shí)現的方便性，平衡這兩方面的要求；
綜合考慮查詢(xún)的方便性與數據冗余如何保證數據的一致性?xún)煞矫娴膽?，平衡這兩方面的應用；
3) 完整性：數據項需明確是否非空選項，保證數據的完整性；
4) 一致性：相同數據項的命名、類(lèi)型、長(cháng)度應保持一致；
5) 關(guān)聯(lián)性：表與表采用弱關(guān)聯(lián)，系統數據的正確性需要業(yè)務(wù)處理邏輯來(lái)保證；過(guò)程表可以關(guān)聯(lián)結果表，結果表不能關(guān)聯(lián)過(guò)程表，結果表盡可能做到無(wú)狀態(tài)；
6) 可維護的數據項不能做主鍵；
7) 主鍵和外鍵（數模中體現，數據庫中不體現）要建立索引；
8) 所有字段都需要有域類(lèi)型，屬于域類(lèi)型的數據項類(lèi)型需要引用域，不允許重復定義；
9) 字段需注釋?zhuān)⑨寖热菖c格式要統一，格式上注釋第一行為字段中文名稱(chēng)，字典字段的注釋要包含枚舉值，并且枚舉值要和業(yè)務(wù)變更同步；
10) 每個(gè)表中盡量有修改時(shí)間與創(chuàng )建時(shí)間，并且保證非空性；盡量有備用和備注字段，用于系統運維。
4. 功能設計
1) 合適性：功能性需求與非功能性需求需要綜合考慮。功能性需求要精簡(jiǎn)，功能模型未明確定義的輔助功能（包括查詢(xún)型、匯總型等）盡量不加，除非該功能操作太多的表，保證功能粒度的一致性與合理性，解決問(wèn)題的明確性及系統業(yè)務(wù)過(guò)程的簡(jiǎn)單性；明確功能約束并說(shuō)明清楚；
2) 穩定性：明確哪些是不變的功能，形成穩定的結構；
3) 擴展性：明確哪些是可變的功能，使可變的功能易于擴展；
4) 復用性：抽取公用的東西，加強公共功能的復用；
5) 單一性：同樣的功能只在一個(gè)地方出現，禁止在多個(gè)地方出現。
5. 頁(yè)面設計
1) 功能性：滿(mǎn)足業(yè)務(wù)功能，達到用戶(hù)基本的功能需求；
2) 清晰性：信息要清晰明確，防止晦澀語(yǔ)言或描述不清楚的地方；
3) 易用性：分區分層與頁(yè)面布局合理，符合用戶(hù)操作習慣；
4) 友好性：頁(yè)面樣式風(fēng)格應貼近工作氛圍，使用戶(hù)可以很好地融入系統；
5) 交互性：應有必要的信息提示與操作步驟引導，降低系統對使用人員要求；
6) 整體風(fēng)格的一致性；
7) 必輸項采用*表示，在頁(yè)面原型中標識；如果不輸入點(diǎn)擊保存，提示請輸入XXX！，在詳細設計不用描述；
8) 復選框選擇后操作提示
明細、導出、打?。喝绻麨檫x擇或選擇多條記錄，提示請選擇一條記錄！，在詳細設計不用描述；
刪除：如果不支持批量刪除，提示請選擇一條記錄！，如果支持批量刪除，提示請選擇記錄，如果已選記錄不符合刪除條件，提示記錄不能刪除：xxx（原因）！，刪除時(shí)詢(xún)問(wèn)確認刪除？，在詳細設計不用描述；
修改：如果未選擇或選擇多條記錄，提示請選擇一條記錄！，如果已選記錄不符合修改條件的記錄，提示記錄不能修改：xxx（原因）！，在詳細設計不用描述；
9) 操作成功后提示
新增記錄保存成功后，提示[單據編號] [單據類(lèi)型]生成成功??；
修改記錄保存成功后，提示[單據編號] [單據類(lèi)型] [操作類(lèi)型]成功?。ú僮黝?lèi)型：修改、派工等）；
刪除記錄功能后，提示刪除成功??；
10) 操作失敗后提示[操作類(lèi)型]失?。簒xx（原因）（操作類(lèi)型：修改、派工等）；
11) 查詢(xún)條件可多選時(shí)，已選擇項在文本框中的展示格式：項1,項2,項3，各選擇項間以,（英文半角逗號）分隔；
12) 通用幫助框：通用幫助框的查詢(xún)條件應支持默認匹配父頁(yè)面的查詢(xún)條件，即通用幫助框的鏈接支持傳遞參數。
6. 接口設計
1) 接口中方法的返回不能為void，至少也要通知調用者，操作是否成功
2) 接上條，凡是返回操作是否成功的方法，返回類(lèi)型要設置為int而不是boolean
3) 方法名只能使用英文，盡量簡(jiǎn)單易懂，駝峰規則，首字母小寫(xiě)，不得含有數字
4) 方法名最好使用動(dòng)賓結構。
5) 接口中所有方法都必須寫(xiě)注釋。
6) 接口中所有方法都必須是public的。
7) 每個(gè)方法的位置應當是明確的，不要將不屬于某接口的方法放入該接口中，也不要寫(xiě)功能重復的方法。
7. 兼容性、擴展性
1) 穩定性：系統的擴展首先要保證系統的穩定，盡量明確哪些是不變的，哪些是可變的，可變的部分放在具體的實(shí)現，抽象不變的接口，最有效的方式是職責單一；
2) 擴展性：分析明確可變部分，使可變部分通過(guò)不同的實(shí)現或配置達到系統擴展；
3) 簡(jiǎn)單性：盡量通過(guò)簡(jiǎn)單的配置或很方便地實(shí)現相應的接口，達到系統擴展；配置的地方盡量少，配置的內容盡量少，配置的功能與影響是十分明確。
功能設計說(shuō)明書(shū)模板
1. 文檔介紹
1.1編寫(xiě)目的
說(shuō)明文檔的編寫(xiě)目的
1.2文檔范圍
說(shuō)明文檔的主要內容
1.3讀者對象
說(shuō)明文檔的讀者對象
1.4術(shù)語(yǔ)與縮寫(xiě)解釋
術(shù)語(yǔ)或縮寫(xiě)
解釋
1.5參考資料
序號
文檔名稱(chēng)
文檔編號
版本
發(fā)布日期
1
2
2系統概述
2.1系統說(shuō)明
介紹系統的名稱(chēng)、任務(wù)提出者、開(kāi)發(fā)者、用戶(hù)群
2.2項目背景
介紹項目的背景，在什么樣的背景下產(chǎn)生該產(chǎn)品
2.3系統任務(wù)
介紹產(chǎn)品的目標與愿景，產(chǎn)品要能滿(mǎn)足什么樣的需求，要達到什么樣一個(gè)效果
3.需求說(shuō)明
3.1整體需求
描述產(chǎn)品的整體需求，產(chǎn)品要能滿(mǎn)足什么需求，要達到什么效果
3.2功能需求
描述產(chǎn)品的功能性需求，產(chǎn)品要包含哪些功能或者服務(wù)接口。首先要指定需求的編號規則，然后按照規則對功能性需求進(jìn)行模塊劃分和編號，最后要對每一個(gè)需求進(jìn)行詳細描述
3.3需求編號規則
描述需求的編號規則
3.4總體模塊劃分
描述需求的模塊劃分情況
4.功能性需求
4.1模塊1編號
模塊名稱(chēng)
模塊簡(jiǎn)介
模塊功能列表
序號
一級功能
二級功能
功能名稱(chēng)
功能編號
功能名稱(chēng)
功能編號
1
2
3
4
4.1.1一級功能1編號
描述本功能
4.1.1.1二級功能1編號
描述本功能
4.1.1.2二級功能2編號
描述本功能
4.1.2二級功能2編號
描述本功能
4.1.2.1二級功能1編號
描述本功能
4.1.2.2二級功能2編號
描述本功能
4.2模塊2編號
模塊名稱(chēng)
模塊簡(jiǎn)介
模塊功能列表
序號
一級功能
二級功能
功能名稱(chēng)
功能編號
功能名稱(chēng)
功能編號
1
2
3
4
4.2.1一級功能1編號
描述本功能
4.2.1.1二級功能1編號
描述本功能
4.2.1.2二級功能2編號
描述本功能
4.2.2二級功能2編號
描述本功能
4.2.2.1二級功能1編號
描述本功能
4.2.2.2二級功能2編號
描述本功能
5.界面設計
5.1界面的功能
5.1.1前臺界面
功能列表或圖示
5.1.2后臺界面
功能列表或圖示
5.2界面關(guān)系
5.2.1頁(yè)面1
頁(yè)面說(shuō)明
說(shuō)明
頁(yè)面遷移圖
圖示
頁(yè)面截圖
截圖
5.2.2頁(yè)面2
頁(yè)面說(shuō)明
說(shuō)明
頁(yè)面遷移圖
圖示
頁(yè)面截圖
截圖