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