📌 참고: 이 문서는 awesome Claude Code 문서의 원문 + 레퍼런스입니다.

• 원문 링크를 방문하셔서 복사해서 사용하셔도 됩니다
• 이 파일을 .claude/skills/ 하위에 복사하여 스킬로 등록할 수도 있습니다

(26.03.15 기준)

문서 업데이트 커맨드: 구현 문서 업데이트

문서 분석

1. 현재 문서 상태를 검토합니다:

   • specs/implementation_status.md에서 전체 프로젝트 상태를 확인합니다
   • 구현된 페이즈 문서(specs/phase{N}_implementation_plan.md)를 검토합니다
   • specs/flutter_structurizr_implementation_spec.md 및 specs/flutter_structurizr_implementation_spec_updated.md를 검토합니다
   • specs/testing_plan.md를 검토하여 최근 테스트 통과, 실패, 변경 사항을 반영하고 있는지 확인합니다
   • CLAUDE.md와 README.md에서 프로젝트 전반의 문서를 확인합니다
   • CLAUDE.md에 새로운 교훈이나 모범 사례가 있는지 확인하고 문서화합니다

2. 구현 및 테스트 결과를 분석합니다:

   • 마지막 페이즈에서 구현된 내용을 검토합니다
   • 테스트 결과와 커버리지를 검토합니다
   • 구현 중 발견된 새로운 모범 사례를 식별합니다
   • 구현 과정의 문제점과 해결 방법을 기록합니다
   • 업데이트된 문서를 최근 구현 및 테스트 결과와 교차 참조하여 정확성을 확인합니다

문서 업데이트

1. 페이즈 구현 문서를 업데이트합니다:

   • 완료된 작업에 ✅ 상태를 표시합니다
   • 구현 완료율을 업데이트합니다
   • 구현 접근 방식에 대한 상세 메모를 추가합니다
   • 원래 계획에서 벗어난 부분을 근거와 함께 문서화합니다
   • 필요시 새 섹션을 추가합니다 (교훈, 모범 사례)
   • 복잡한 컴포넌트에 대한 구체적인 구현 세부사항을 문서화합니다
   • 해당 페이즈에서 발견된 새로운 트러블슈팅 팁이나 워크플로우 개선사항을 요약하여 포함합니다

2. 구현 상태 문서를 업데이트합니다:

   • 페이즈 완료율을 업데이트합니다
   • 컴포넌트의 구현 상태를 추가하거나 업데이트합니다
   • 구현 접근 방식과 결정 사항에 대한 메모를 추가합니다
   • 구현 중 발견된 모범 사례를 문서화합니다
   • 극복한 문제와 적용한 해결 방법을 기록합니다

3. 구현 사양 문서를 업데이트합니다:

   • 완료된 항목에 ✅ 또는 취소선을 표시하되 원래 요구사항은 보존합니다
   • 적절한 곳에 구현 세부사항 메모를 추가합니다
   • 구현된 파일과 클래스에 대한 참조를 추가합니다
   • 경험을 바탕으로 구현 가이드를 업데이트합니다

4. 필요시 CLAUDE.md와 README.md를 업데이트합니다:

   • 새로운 모범 사례를 추가합니다
   • 프로젝트 상태를 업데이트합니다
   • 새로운 구현 가이드를 추가합니다
   • 알려진 이슈나 제한사항을 문서화합니다
   • 새로운 기능을 포함하도록 사용 예시를 업데이트합니다

5. 새로운 테스트 절차를 문서화합니다:

   • 생성된 테스트 파일에 대한 세부사항을 추가합니다
   • 테스트 실행 방법을 포함합니다
   • 테스트 커버리지를 문서화합니다
   • 복잡한 컴포넌트의 테스트 접근 방식을 설명합니다

문서 포맷 및 구조

1. 일관된 문서 스타일을 유지합니다:

   • 명확한 제목과 섹션을 사용합니다
   • 도움이 되는 경우 코드 예시를 포함합니다
   • 상태 표시자(✅, ⚠️, ❌)를 일관되게 사용합니다
   • 올바른 Markdown 포맷을 유지합니다

2. 문서 완전성을 확보합니다:

   • 구현된 모든 기능을 다룹니다
   • 사용 예시를 포함합니다
   • API 변경 또는 추가 사항을 문서화합니다
   • 일반적인 이슈에 대한 트러블슈팅 가이드를 포함합니다

가이드라인

• 새 사양 파일을 생성하지 마세요
• specs/ 디렉토리의 기존 파일을 업데이트하세요
• 일관된 문서 스타일을 유지하세요
• 적절한 곳에 실용적인 예시를 포함하세요
• 관련 문서 섹션을 교차 참조하세요
• 모범 사례와 교훈을 문서화하세요
• 프로젝트 진행 상황에 대한 명확한 상태 업데이트를 제공하세요
• 수치 완료율을 업데이트하세요
• 문서가 실제 구현을 반영하는지 확인하세요

완료 후 다음을 포함한 문서 업데이트 요약을 제공하세요:

1. 업데이트된 파일
2. 주요 문서 변경 사항
3. 업데이트된 완료율
4. 새로 문서화된 모범 사례
5. 이번 페이즈 이후 전체 프로젝트 상태