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