mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 15:13:28 +08:00
a693d2e023
- commands: 18 files (build-fix, checkpoint, code-review, e2e, eval, go-build, go-review, go-test, learn, orchestrate, plan, refactor-clean, setup-pm, tdd, test-coverage, update-codemaps, update-docs, verify) - agents: 12 files (architect, build-error-resolver, code-reviewer, database-reviewer, doc-updater, e2e-runner, go-build-resolver, go-reviewer, planner, refactor-cleaner, security-reviewer, tdd-guide)
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# 문서 업데이트
|
|
|
|
문서를 코드베이스와 동기화하고, 원본 소스 파일에서 생성합니다.
|
|
|
|
## 1단계: 원본 소스 식별
|
|
|
|
| 소스 | 생성 대상 |
|
|
|------|----------|
|
|
| `package.json` scripts | 사용 가능한 커맨드 참조 |
|
|
| `.env.example` | 환경 변수 문서 |
|
|
| `openapi.yaml` / 라우트 파일 | API 엔드포인트 참조 |
|
|
| 소스 코드 exports | 공개 API 문서 |
|
|
| `Dockerfile` / `docker-compose.yml` | 인프라 설정 문서 |
|
|
|
|
## 2단계: 스크립트 참조 생성
|
|
|
|
1. `package.json` (또는 `Makefile`, `Cargo.toml`, `pyproject.toml`) 읽기
|
|
2. 모든 스크립트/커맨드와 설명 추출
|
|
3. 참조 테이블 생성
|
|
|
|
## 3단계: 환경 변수 문서 생성
|
|
|
|
1. `.env.example` 읽기
|
|
2. 모든 변수와 용도 추출
|
|
3. 필수 vs 선택으로 분류
|
|
4. 예상 형식과 유효 값 문서화
|
|
|
|
## 규칙
|
|
|
|
- **단일 원본**: 항상 코드에서 생성, 생성된 섹션을 수동으로 편집하지 않기
|
|
- **수동 섹션 보존**: 생성된 섹션만 업데이트; 수기 작성 내용은 그대로 유지
|
|
- **생성된 콘텐츠 표시**: 생성된 섹션 주변에 `<!-- AUTO-GENERATED -->` 마커 사용
|
|
- **요청 없이 문서 생성하지 않기**: 커맨드가 명시적으로 요청한 경우에만 새 문서 파일 생성
|