name: document
description: 문서화, API 문서, 아키텍처 문서, README 작성/갱신 요청 시 자동 활성화됩니다. 코드 변경에 맞춰 관련 문서를 자동으로 생성하거나 업데이트합니다. "문서화해줘", "README 작성", "API 문서", "아키텍처 정리" 등의 요청에 반응합니다.

문서화 전문가

활성화 조건

• "문서화해줘", "문서 작성", "README", "API 문서" 요청
• "아키텍처 정리", "설계 문서", "기술 문서" 요청
• 코드 변경 후 관련 문서 업데이트 필요 시
• "변경 이력", "릴리스 노트", "CHANGELOG" 요청

다른 스킬과의 차이

• document: 문서 생성/갱신 전문. 코드→문서 동기화.
• pm: 기획 문서, 태스크 분해. document는 기술 문서 중심.
• commit: 커밋 메시지 작성. document는 프로젝트 문서 전체.

문서 유형

실행 절차

Step 1: 문서화 범위 파악

• 대상 코드/모듈 확인
• 기존 문서 유무 확인
• 문서 유형 결정 (신규 생성 / 기존 갱신)
• 대상 독자 확인 (개발자 / 사용자 / 팀원)

Step 2: 코드 분석

• 대상 코드 읽기 (함수 시그니처, 타입, 주석)
• 의존성과 데이터 흐름 추적
• 공개 API와 내부 구현 구분
• 기존 테스트에서 사용 패턴 파악

Step 3: 문서 작성/갱신

신규 생성 시:
- 문서 유형에 맞는 템플릿 적용
- 코드에서 추출한 정보로 내용 채우기
- 예시 코드/사용법 포함

기존 갱신 시:
- 변경된 코드와 문서 diff 비교
- 변경 부분만 surgical하게 업데이트
- 기존 문서 스타일/톤 유지

Step 4: 검증

• 문서 내용과 실제 코드 일치 여부 확인
• 예시 코드가 실제 동작 가능한지 확인
• 링크, 경로, 파일명 유효성 검증
• 한국어 문서 기준 적용 (식별자는 영어 유지)

Thinking Cycle (필수)

모든 작업에 사고 사이클을 적용한다. 상세: ../_shared/resources/thinking-cycle.md

1. 질문: 실행 전 최소 1개 소크라테스 질문 → 답변 전 진행 금지
2. 결정: 트레이드오프 존재 시 선택지 제시 → 근거 있는 선택 요구
3. 실행: Phase 0, 1 완료 후에만 진입
4. 코드 리딩: 변경 코드 이해도 점검 (레벨 C 기본)
5. 회고: 작업 완료 후 사용자 회고 → .claude/reflections/YYYY-MM-DD.md에 기록

핵심 규칙

1. 코드가 진실: 문서는 코드 기반. 추측 작성 금지.
2. 최소 충분 원칙: 필요한 정보만 포함. 과도한 문서화는 유지보수 부채.
3. DRY 문서: 같은 내용 중복 작성 금지. 한 곳에 쓰고 참조.
4. 기존 스타일 존중: 프로젝트의 기존 문서 톤과 형식 유지.
5. 예시 우선: 긴 설명보다 동작하는 예시 코드가 효과적.
6. 변경 동기화: 코드 변경 시 관련 문서도 함께 업데이트.

보고 형식

## 문서화 결과

### What
- [생성/갱신한 문서 목록]

### Why
- [문서화 이유, 어떤 변경에 의한 것인지]

### Result
- [문서 위치, 주요 내용 요약]
- [추가 조치 필요 사항]

참조 리소스

resources/ 참조:
- 실행 프로토콜: execution-protocol.md
- 문서 템플릿: doc-templates.md
- 에러 대응: error-playbook.md