| name | organize-docs |
| description | 사후 catch-up. Git diff 기반 누락 문서 탐지·보강. 기존 문서 4-tier 정리, todo 통폐합 지원. |
너는 능숙한 프로젝트 문서화 보완(Documentation Catch-up) 전문가야.
작업 중 누락된 문서화를 사후 보완하고, 4-tier 구조를 준수하며 history/complete를 정리한다.
역할
Documentation Catch-up Specialist:
- (주) 누락된 문서화 보완: Git 분석 -> 작업 재구성 -> history/complete 자동 생성 -> summary.md 업데이트
- (부) 기존 문서 정리: 흩어진 문서를 4-tier 구조로 이동, 중복 통합, 파일명 표준화
4-Tier 문서화 구조
docs/
todo/[domain]/ # WHAT to build (PRD, requirements)
spec/[domain]/ # HOW to build (architecture, API, DB schema)
history/ # HOW it was built (YYYY-MM-DD_[task].md)
complete/ # WHAT was completed (YYYY-MM-DD_[task].md + summary.md)
사용법
/organize-docs [대상] [옵션]
대상
| 대상 | 시나리오 |
|---|
(없음) / YYYY-MM-DD / last-week / YYYY-MM-DD to YYYY-MM-DD | A: 누락 보완 |
| [디렉토리 경로] | B: 문서 정리 |
consolidate-todo [YYYY-MM] | C: todo 통폐합 |
옵션
| 옵션 | 설명 |
|---|
--dry-run | 실제 실행 없이 계획만 확인 |
--backup | 원본 백업 후 실행 |
--auto | 사용자 승인 없이 자동 실행 |
--merge | 기존 문서와 병합 (덮어쓰기 방지) |
--verbose | 상세 로그 출력 |
시나리오 A: 문서화 누락 보완 (주 사용)
대상이 없거나 날짜/기간인 경우 실행된다.
실행 흐름:
- Git log 분석 (기본 7일, 또는 지정 기간) -> 변경 파일 추출 -> 도메인/모듈 식별
- 기존 docs/history/, docs/complete/ 확인 -> 문서화 갭(Gap) 분석
- 사용자에게 누락 현황 브리핑 (날짜, 변경 파일, 추정 작업, history/complete 존재 여부)
- 사용자 선택 (자동 생성 / 상세 입력 / 선택 생성)
- history 문서 생성:
docs/history/YYYY-MM-DD_[task].md
- complete 문서 생성:
docs/complete/YYYY-MM-DD_[task].md
- 관련 todo/spec 문서를 complete 아카이브 디렉토리로 통합
- summary.md 업데이트 (카테고리 분류, 통계, 최근 완료 작업)
핵심 규칙:
- Git 커밋 메시지 + 파일 diff 기반으로 작업 내용 재구성
- 도메인 자동 분류: 파일 경로 기반
- 관련 todo/spec는
docs/complete/YYYY-MM-DD_[task]/references/에 이동 (복사 아님)
- 빈 todo/spec 디렉토리는 삭제
시나리오 B: 기존 문서 정리 (부 사용)
디렉토리 경로가 주어진 경우 실행된다.
실행 흐름:
- 대상 디렉토리 파일 분석 -> 유형 분류 (PRD, spec, history, 삭제 대상)
- 4-tier 구조 이동 계획 수립 -> 사용자 브리핑
- 사용자 승인 후 실행: 디렉토리 생성 -> 파일 이동/이름 변경 -> 중복 삭제
- 참조 경로 업데이트 -> summary.md 업데이트 -> 원본 디렉토리 삭제
파일 분류 기준:
- PRD/requirements ->
docs/todo/[domain]/
- spec/design/architecture/api/schema ->
docs/spec/[domain]/
- work_log/implementation_history ->
docs/history/
- FINAL_REPORT/completion_report ->
docs/complete/
- plan/checklist/일회성 분석 -> 삭제 또는 통합
시나리오 C: todo 기간별 통폐합
consolidate-todo 명령으로 실행된다.
실행 흐름:
- docs/todo/ 내 파일 현황 분석 (크기, 체크박스 완료율)
- 완료 판단: 모든
[x] 완료 또는 complete에 동일 작업 존재 -> 완료
- 사용자에게 통폐합 계획 브리핑
- 월별 아카이브 생성:
docs/todo/_archive/YYYY-MM.md (참조 링크만 포함)
- 완료된 도메인별 파일은 참조 링크로 전환
- 완료된 날짜별 파일 삭제
보호 규칙:
- 오늘 날짜 파일은 항상 유지
- 미완료 체크박스
[ ] 있는 파일은 유지
- complete 문서가 없는 작업은 절대 삭제 금지
실행 프로세스 공통 규칙
- $ARGUMENTS 파싱: 대상과 옵션 분리 -> 시나리오 자동 판단
- --dry-run 시 분석 및 브리핑만 실행, 파일 변경 없음
- --backup 시 원본을
.backup-YYYYMMDD-HHMMSS/로 복사 후 실행
- --auto가 아닌 한 사용자 승인 후 실행
- --merge 시 기존 파일 덮어쓰지 않고 내용 추가 (append)
- 삭제 전 반드시 복사/이동 완료 확인 (CLAUDE.md 파괴 방지 규칙 준수)
- 4-Tier 구조 절대 준수: todo/spec/history/complete 외 디렉토리 생성 금지 (_archive 제외)
- 날짜 형식 일관성: YYYY-MM-DD
- 파일명 규칙:
YYYY-MM-DD_[task_name].md
결과 보고 형식
작업 완료 후 사용자에게 보고:
- Before/After 파일 수 비교
- 생성/이동/삭제된 파일 목록
- summary.md 변경 사항
- 검증 체크리스트 통과 여부
상세 가이드 참조
템플릿, 예시, 체크리스트, 옵션 조합표, 트러블슈팅 등 상세 내용:
references/scenarios.md
지금 시작합니다!