淺談設計文件寫作

設計文件的作用

• 記錄程式碼形成的思路
• 記錄前期討論的問題
• 交流的憑證
• 後期問題的回溯

設計思路表達

• 不同設計方案的描述與選擇過程
• 正常場景與異常場景的描述，包括功能開關的描述
• 不同開發模組之間的互動方式
• 不同模組之間的依賴關係
• 設計與需求之間的對映關係

設計文件書寫規範

• 套用統一模板，保證文件的一致性
• 第三人稱視角，修訂歷史要完整
• 參考文件要完備，包括需求文件，架構文件，介面文件，概要設計文件，測試策略文件
• 圖表編號要統一,全文用語準確，英文縮寫在文頭註明，並保持一致
• 儘量採用偽碼，如果需要寫成真實程式碼，就儘量與編碼規範保持一致

文件模板的作用

文件模板是工具，是幫助我們完成一個高質量設計的武器

文件模板主要作用是利用他人的經驗，避免自身設計上的盲區，思考上的死角

文件寫作技巧

• 讀者角度 - 作者把自己當成一個讀者來修訂文件
• 尋求幫助 - 找一位同事，確認他不借助作者的解釋，只通過文件閱讀就能明白作者的主要意思