インターフェース設計 は何をしますか?
「ソフトウェア設計の哲学」の「二度設計する」に基づく:最初のアイデアが最善であるとは限らない。複数の根本的に異なる設計を生成し、比較する。
ワークフロー
1. 要件の収集
設計の前に、以下を理解する:
- このモジュールはどのような問題を解決するか?
- 呼び出し元は誰か?(他のモジュール、外部ユーザー、テスト)
- 主要な操作は何か?
- 制約はあるか?(パフォーマンス、互換性、既存のパターン)
- 内部に隠蔽すべきものと外部に公開すべきものは何か?
質問:「このモジュールは何をする必要があるか?誰がそれを使うか?」
2. 設計の生成(並列サブエージェント)
Taskツールを使用して3つ以上のサブエージェントを同時に起動する。各エージェントは根本的に異なるアプローチを生成しなければならない。
各サブエージェントのプロンプトテンプレート:
インターフェースを設計してください:[モジュールの説明]
要件:[収集した要件]
この設計の制約:[各エージェントに異なる制約を割り当てる]
- エージェント1:「メソッド数を最小限に - 最大1〜3メソッドを目指す」
- エージェント2:「柔軟性を最大化 - 多くのユースケースをサポート」
- エージェント3:「最も一般的なケースに最適化」
- エージェント4:「[特定のパラダイム/ライブラリ]から着想を得る」
出力形式:
1. インターフェースシグネチャ(型/メソッド)
2. 使用例(呼び出し元がどのように使うか)
3. この設計が内部に隠蔽するもの
4. このアプローチのトレードオフ
3. 設計の提示
各設計を以下の内容で提示する:
- インターフェースシグネチャ - 型、メソッド、パラメータ
- 使用例 - 呼び出し元が実際にどのように使うか
- 隠蔽するもの - 内部に隠される複雑性
ユーザーが比較前に各アプローチを理解できるよう、設計を順次提示する。
4. 設計の比較
すべての設計を提示した後、以下の基準で比較する:
- インターフェースの単純さ:より少ないメソッド、よりシンプルなパラメータ
- 汎用性 vs 特化:柔軟性と焦点のバランス
- 実装効率:形状が効率的な内部実装を可能にするか
- 深さ:重要な複雑性を隠蔽する小さなインターフェース(良い) vs 薄い実装を持つ大きなインターフェース(悪い)
- 正しい使用のしやすさ vs 誤用のしやすさ
トレードオフについては表ではなく散文で議論する。設計同士が最も異なる点を強調する。
5. 合成
多くの場合、最良の設計は複数のオプションからの洞察を組み合わせる。以下の質問をする:
- 「どの設計があなたの主要なユースケースに最も適していますか?」
- 「他の設計から取り入れる価値のある要素はありますか?」
評価基準
「ソフトウェア設計の哲学」より:
インターフェースの単純さ:より少ないメソッド、よりシンプルなパラメータ = 学習と正しい使用が容易。
汎用性:変更なしで将来のユースケースに対応できる。ただし、過度な一般化には注意。
実装効率:インターフェースの形状が効率的な実装を可能にするか? それとも不自然な内部構造を強制するか?
深さ:重要な複雑性を隠蔽する小さなインターフェース = 深いモジュール(良い)。薄い実装を持つ大きなインターフェース = 浅いモジュール(避けるべき)。
アンチパターン
- サブエージェントに類似した設計を生成させない - 根本的な違いを強制する
- 比較をスキップしない - 価値は対比にある
- 実装しない - これは純粋にインターフェースの形状についてである
- 実装の労力に基づいて評価しない