設計一個介面
基於《軟體設計哲學》中的「設計它兩次」:你的第一個想法不太可能是最好的。生成多個截然不同的設計,然後進行比較。
工作流程
1. 收集需求
在設計之前,請了解:
- 這個模組解決什麼問題?
- 呼叫者是誰?(其他模組、外部使用者、測試)
- 關鍵操作有哪些?
- 有任何限制嗎?(效能、相容性、現有模式)
- 哪些應隱藏在內部,哪些應公開?
問:「這個模組需要做什麼?誰會使用它?」
2. 生成設計(平行子代理)
使用 Task 工具同時生成 3 個以上的子代理。每個子代理必須產生一個截然不同的方法。
每個子代理的提示模板:
為:[模組描述] 設計一個介面
需求:[已收集的需求]
此設計的限制:[為每個代理指定不同的限制]
- 代理 1:「將方法數量降到最低 - 目標最多 1-3 個方法」
- 代理 2:「最大化靈活性 - 支援多種使用案例」
- 代理 3:「針對最常見的情況進行最佳化」
- 代理 4:「從 [特定範例/函式庫] 獲得靈感」
輸出格式:
1. 介面簽章(型別/方法)
2. 使用範例(呼叫者如何使用)
3. 此設計隱藏了什麼在內部
4. 此方法的取捨
3. 展示設計
展示每個設計,包括:
- 介面簽章 - 型別、方法、參數
- 使用範例 - 呼叫者在實務上如何實際使用
- 隱藏的內容 - 保留在內部的複雜度
依序展示設計,讓使用者在比較之前能吸收每種方法。
4. 比較設計
在展示所有設計後,根據以下標準進行比較:
- 介面簡單性:更少的方法、更簡單的參數
- 通用 vs 專用:靈活性 vs 專注度
- 實作效率:形狀是否允許高效的內部實作?
- 深度:隱藏顯著複雜度的小型介面(好) vs 帶有淺層實作的大型介面(壞)
- 正確使用的容易度 vs 誤用的容易度
用文字討論取捨,不要用表格。強調設計之間差異最大的地方。
5. 綜合
通常最好的設計會結合多個選項的見解。問:
- 「哪個設計最符合你的主要使用案例?」
- 「有沒有來自其他設計的元素值得整合?」
評估標準
來自《軟體設計哲學》:
介面簡單性:更少的方法、更簡單的參數 = 更容易學習和正確使用。
通用性:能在不變更的情況下處理未來使用案例。但要小心過度泛化。
實作效率:介面形狀是否允許高效實作?或強制使用笨拙的內部結構?
深度:隱藏顯著複雜度的小型介面 = 深度模組(好)。帶有淺層實作的大型介面 = 淺層模組(避免)。
反模式
- 不要讓子代理產生相似的設計 - 強制要求截然不同
- 不要跳過比較 - 價值在於對比
- 不要實作 - 這純粹是關於介面形狀
- 不要根據實作工作量來評估