mirror of https://github.com/affaan-m/everything-claude-code.git synced 2026-03-30 21:53:28 +08:00

Files

Affaan Mustafa fb7b73a962 docs: address Korean translation review feedback

2026-03-13 00:17:54 -07:00

3.2 KiB

Raw Blame History

name, description

name	description
update-docs	코드베이스를 기준으로 문서를 동기화하고 생성된 섹션을 갱신합니다.

문서 업데이트

문서를 코드베이스와 동기화하고, 원본 소스 파일에서 생성합니다.

1단계: 원본 소스 식별

소스	생성 대상
`package.json` scripts	사용 가능한 커맨드 참조
`.env.example`	환경 변수 문서
`openapi.yaml` / 라우트 파일	API 엔드포인트 참조
소스 코드 exports	공개 API 문서
`Dockerfile` / `docker-compose.yml`	인프라 설정 문서

2단계: 스크립트 참조 생성

package.json (또는 Makefile, Cargo.toml, pyproject.toml) 읽기
모든 스크립트/커맨드와 설명 추출
참조 테이블 생성:

| 커맨드 | 설명 |
|--------|------|
| `npm run dev` | hot reload로 개발 서버 시작 |
| `npm run build` | 타입 체크 포함 프로덕션 빌드 |
| `npm test` | 커버리지 포함 테스트 스위트 실행 |

3단계: 환경 변수 문서 생성

.env.example (또는 .env.template, .env.sample) 읽기
모든 변수와 용도 추출
필수 vs 선택으로 분류
예상 형식과 유효 값 문서화

| 변수 | 필수 | 설명 | 예시 |
|------|------|------|------|
| `DATABASE_URL` | 예 | PostgreSQL 연결 문자열 | `postgres://user:pass@host:5432/db` |
| `LOG_LEVEL` | 아니오 | 로깅 상세도 (기본값: info) | `debug`, `info`, `warn`, `error` |

4단계: 기여 가이드 업데이트

docs/CONTRIBUTING.md를 생성 또는 업데이트합니다:

개발 환경 설정 (사전 요구 사항, 설치 단계)
사용 가능한 스크립트와 용도
테스트 절차 (실행 방법, 새 테스트 작성 방법)
코드 스타일 적용 (linter, formatter, pre-commit hook)
PR 제출 체크리스트

5단계: 운영 매뉴얼 업데이트

docs/RUNBOOK.md를 생성 또는 업데이트합니다:

배포 절차 (단계별)
헬스 체크 엔드포인트 및 모니터링
일반적인 이슈와 해결 방법
롤백 절차
알림 및 에스컬레이션 경로

6단계: 오래된 항목 점검

90일 이상 수정되지 않은 문서 파일 찾기
최근 소스 코드 변경 사항과 교차 참조
잠재적으로 오래된 문서를 수동 검토 대상으로 표시

7단계: 요약 표시

문서 업데이트
──────────────────────────────
업데이트: docs/CONTRIBUTING.md (스크립트 테이블)
업데이트: docs/ENV.md (새 변수 3개)
플래그:   docs/DEPLOY.md (142일 경과)
건너뜀:   docs/API.md (변경 사항 없음)
──────────────────────────────

규칙

단일 원본: 항상 코드에서 생성하고, 생성된 섹션을 수동으로 편집하지 않기
수동 섹션 보존: 생성된 섹션만 업데이트; 수기 작성 내용은 그대로 유지
생성된 콘텐츠 표시: 생성된 섹션 주변에  마커 사용
요청 없이 문서 생성하지 않기: 커맨드가 명시적으로 요청한 경우에만 새 문서 파일 생성

3.2 KiB Raw Blame History