인터페이스 설계하기은(는) 무엇을 하나요?
"소프트웨어 설계의 철학"에 나오는 "두 번 설계하기(Design It Twice)"에서 영감을 받았습니다: 여러분의 첫 번째 아이디어가 최고일 가능성은 낮습니다. 근본적으로 다른 여러 설계를 생성한 후 비교하세요.
워크플로우
1. 요구사항 수집
설계에 앞서 다음을 이해하세요:
- 이 모듈은 어떤 문제를 해결하나요?
- 호출자는 누구인가요? (다른 모듈, 외부 사용자, 테스트)
- 핵심 작업은 무엇인가요?
- 제약 조건이 있나요? (성능, 호환성, 기존 패턴)
- 내부에 숨겨야 할 것과 외부에 노출해야 할 것은 무엇인가요?
질문: "이 모듈은 무엇을 해야 하나요? 누가 사용할 것인가요?"
2. 설계 생성 (병렬 하위 에이전트)
Task 도구를 사용하여 동시에 3개 이상의 하위 에이전트를 생성하세요. 각 에이전트는 근본적으로 다른 접근 방식을 생성해야 합니다.
각 하위 에이전트를 위한 프롬프트 템플릿:
인터페이스 설계 대상: [모듈 설명]
요구사항: [수집된 요구사항]
이 설계의 제약 조건: [각 에이전트에 다른 제약 조건 할당]
- 에이전트 1: "메서드 수 최소화 - 최대 1~3개 메서드 목표"
- 에이전트 2: "유연성 극대화 - 다양한 사용 사례 지원"
- 에이전트 3: "가장 일반적인 사용 사례에 최적화"
- 에이전트 4: "[특정 패러다임/라이브러리]에서 영감 받기"
출력 형식:
1. 인터페이스 시그니처 (타입/메서드)
2. 사용 예시 (호출자가 어떻게 사용하는지)
3. 이 설계가 내부적으로 숨기는 것
4. 이 접근 방식의 트레이드오프
3. 설계 제시
각 설계를 다음과 함께 제시하세요:
- 인터페이스 시그니처 - 타입, 메서드, 매개변수
- 사용 예시 - 호출자가 실제로 어떻게 사용하는지
- 숨기는 것 - 내부에 감춰진 복잡성
사용자가 각 접근 방식을 비교하기 전에 충분히 이해할 수 있도록 설계를 순차적으로 제시하세요.
4. 설계 비교
모든 설계를 제시한 후, 다음 기준으로 비교하세요:
- 인터페이스 단순성: 메서드 수가 적고 매개변수가 단순할수록 좋음
- 일반 목적 vs 특화: 유연성 vs 집중도
- 구현 효율성: 설계 형태가 효율적인 내부 구현을 가능하게 하는가?
- 깊이: 작은 인터페이스가 상당한 복잡성을 숨기는 것(좋음) vs 큰 인터페이스에 얇은 구현(나쁨)
- 올바른 사용의 용이성 vs 잘못된 사용의 가능성
표가 아닌 문장으로 트레이드오프를 논의하세요. 설계 간 차이가 가장 큰 지점을 강조하세요.
5. 종합
종종 최고의 설계는 여러 옵션에서 인사이트를 결합한 것입니다. 다음 질문을 던지세요:
- "어느 설계가 주요 사용 사례에 가장 적합한가요?"
- "다른 설계에서 통합할 만한 요소가 있나요?"
평가 기준
"소프트웨어 설계의 철학"에서:
인터페이스 단순성: 메서드 수가 적고 매개변수가 단순할수록 배우고 올바르게 사용하기 쉽습니다.
일반 목적: 변경 없이 미래의 사용 사례를 처리할 수 있습니다. 그러나 과도한 일반화를 주의하세요.
구현 효율성: 인터페이스 형태가 효율적인 구현을 가능하게 하는가? 아니면 어색한 내부 구조를 강제하는가?
깊이: 작은 인터페이스가 상당한 복잡성을 숨기면 깊은 모듈(좋음)입니다. 큰 인터페이스에 얇은 구현은 얕은 모듈(피해야 함)입니다.
안티 패턴
- 하위 에이전트가 비슷한 설계를 생성하지 않도록 하세요 - 근본적인 차이를 강제하세요
- 비교를 건너뛰지 마세요 - 가치는 대조에 있습니다
- 구현하지 마세요 - 이는 순수하게 인터페이스 형태에 관한 것입니다
- 구현 노력을 기준으로 평가하지 마세요