스크립트, 스키마, 라우트, 내보내기 등 진실 공급원 파일에서 문서를 동기화합니다.
소스 파일이 변경될 때마다 문서를 최신 상태로 유지하고 싶을 때
Lattice 한국어 번역 · 원본 affaan-m/everything-claude-code (841beea). 복사 → 저장하면 Claude Code가 인식합니다.
--- description: 스크립트, 스키마, 라우트, 내보내기 등 소스 파일에서 문서를 동기화합니다. --- # 문서 업데이트 소스-of-truth 파일에서 생성하여 코드베이스와 문서를 동기화합니다. ## 1단계: 소스 식별 | 소스 | 생성 대상 | |--------|-----------| | `package.json` 스크립트 | 사용 가능한 명령어 참조 | | `.env.example` | 환경 변수 문서 | | `openapi.yaml` / 라우트 파일 | API 엔드포인트 참조 | | 소스 코드 내보내기 | 공개 API 문서 | | `Dockerfile` / `docker-compose.yml` | 인프라 설정 문서 | ## 2단계: 스크립트 참조 생성 1. `package.json` (또는 `Makefile`, `Cargo.toml`, `pyproject.toml`)을 읽습니다. 2. 설명과 함께 모든 스크립트/명령어를 추출합니다. 3. 참조 테이블을 생성합니다: ```markdown | Command | Description | |---------|-------------| | `npm run dev` | 핫 리로딩으로 개발 서버 시작 | | `npm run build` | 타입 검사를 포함한 프로덕션 빌드 | | `npm test` | 커버리지를 포함한 테스트 스위트 실행 | ``` ## 3단계: 환경 문서 생성 1. `.env.example` (또는 `.env.template`, `.env.sample`)을 읽습니다. 2. 목적과 함께 모든 변수를 추출합니다. 3. 필수 항목과 선택 항목으로 분류합니다. 4. 예상 형식과 유효한 값을 문서화합니다. ```markdown | Variable | Required | Description | Example | |----------|----------|-------------|---------| | `DATABASE_URL` | Yes | PostgreSQL 연결 문자열 | `postgres://user:pass@host:5432/db` | | `LOG_LEVEL` | No | 로깅의 상세 수준 (기본값: info) | `debug`, `info`, `warn`, `error` | ``` ## 4단계: 기여 가이드 업데이트 `docs/CONTRIBUTING.md`를 다음 내용으로 생성하거나 업데이트합니다: - 개발 환경 설정 (사전 요구 사항, 설치 단계) - 사용 가능한 스크립트 및 해당 목적 - 테스트 절차 (실행 방법, 새 테스트 작성 방법) - 코드 스타일 강제 (린터, 포맷터, 사전 커밋 훅) - PR 제출 체크리스트 ## 5단계: 운영 가이드 업데이트 `docs/RUNBOOK.md`를 다음 내용으로 생성하거나 업데이트합니다: - 배포 절차 (단계별 설명) - 헬스 체크 엔드포인트 및 모니터링 - 일반적인 문제 및 해결 방법 - 롤백 절차 - 알림 및 에스컬레이션 경로 ## 6단계: 오래된 문서 검사 1. 90일 이상 수정되지 않은 문서 파일을 찾습니다. 2. 최근 소스 코드 변경 사항과 교차 참조합니다. 3. 수동 검토가 필요한 잠재적으로 오래된 문서를 플래그 지정합니다. ## 7단계: 요약 표시 ``` Documentation Update ────────────────────────────── Updated: docs/CONTRIBUTING.md (scripts table) Updated: docs/ENV.md (3 new variables) Flagged: docs/DEPLOY.md (142 days stale) Skipped: docs/API.md (no changes detected) ────────────────────────────── ``` ## 규칙 - **단일 소스**: 항상 코드에서 생성하며, 생성된 섹션은 수동으로 편집하지 않습니다. - **수동 섹션 보존**: 생성된 섹션만 업데이트하고, 직접 작성한 내용은 그대로 둡니다. - **생성된 콘텐츠 표시**: 생성된 섹션 주위에 `<!-- AUTO-GENERATED -->` 마커를 사용합니다. - **임의 문서 생성 금지**: 명령어가 명시적으로 요청하는 경우에만 새 문서 파일을 생성합니다.
Claude Code CLI 기준.
아래 버튼으로 복사 → 다음 경로로 저장.
~/.claude/skills/everything-claude-code-169/SKILL.mdClaude Code 채팅창에서 자연어로 부르면 자동 발동:
예) 소스 파일이 변경될 때마다 문서를 최신 상태로 유지하고 싶을 때
트리거가 안 잡히면 SKILL.md의 description 줄에 더 구체적인 한국어 키워드를 추가해보세요.