documentation-and-adrs

# Documentation & ADRs — 아키텍처 결정 기록 + 기술 문서화 > 아키텍처 결정을 **왜** 했는지 기록하고, 나중에 돌아볼 수 있게 만든다. > 코드는 "무엇"을 말하고, 커밋은 "언제"를 말하지만, ADR만이 **"왜"**를 말한다. ## Quick Start ``` /adr # 대화형 ADR 작성 /adr "Redis를 캐시로 선택" # 제목 지정하여 ADR 작성 /adr list # 기존 ADR 목록 조회 /adr status # ADR 현황 (accepted/superseded/deprecated) ``` **공식 호출명:** `/adr` (별칭: `아키텍처 결정`, `decision record`, `기술 문서화`) ## 적용 시점 | 상황 | 적용 | |------|------| | 기술 스택 선택 (DB, 프레임워크, 라이브러리) | O | | 아키텍처 패턴 결정 (모놀리스 vs 마이크로서비스) | O | | 기존 결정 변경/폐기 | O | | 팀 간 API 계약 변경 | O | | 단순 버그 수정, UI 미세 조정 | X | | 이미 ADR이 존재하는 결정 | X (업데이트만) | --- ## CRITICAL: First Actions ### 1. Print Intro ``` Documentation & ADRs — 아키텍처 결정 기록 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 순서: Detect → Interview → Write → Link → Verify ``` ### 2. ADR 디렉토리 감지 ```bash # ADR 디렉토리 찾기 _ADR_DIR="" for dir in docs/adr docs/decisions adr decisions doc/adr; do [ -d "$dir" ] && _ADR_DIR="$dir" && break done # 없으면 생성 제안 if [ -z "$_ADR_DIR" ]; then echo "ADR 디렉토리 없음 — docs/adr/ 생성 권장" _ADR_DIR="docs/adr" fi # 기존 ADR 번호 확인 _LAST_NUM=$(ls "$_ADR_DIR"/[0-9]*.md 2>/dev/null | sort -V | tail -1 | grep -oE '[0-9]+' | head -1) _NEXT_NUM=$(printf "%04d" $(( ${_LAST_NUM:-0} + 1 ))) echo "ADR_DIR: $_ADR_DIR | NEXT: $_NEXT_NUM" ``` --- ## Step 1: 결정 컨텍스트 수집 사용자에게 다음을 질문 (이미 제공된 항목은 스킵): 1. **결정 제목**: 한 줄로 요약 (예: "세션 스토어를 Redis로 전환") 2. **문제 상황**: 어떤 문제를 해결하려는가? 3. **고려한 대안**: 최소 2개 이상 4. **선택한 결정**:...