/update-docs (문서)

다운로드 후 ~/.claude/commands/ 폴더에 복사하여 사용하세요

진실의 소스에서 문서 동기화.

📝

doc-updater 에이전트를 호출하여 문서를 업데이트합니다.

이 커맨드가 하는 일

package.json scripts 섹션 읽기
- 스크립트 참조 테이블 생성
- 주석의 설명 포함
.env.example 읽기
- 모든 환경 변수 추출
- 목적과 형식 문서화
docs/CONTRIB.md 생성:
- 개발 워크플로우
- 사용 가능한 스크립트
- 환경 설정
- 테스트 절차
docs/RUNBOOK.md 생성:
- 배포 절차
- 모니터링 및 알림
- 일반적인 문제와 해결
- 롤백 절차
오래된 문서 식별:
- 90일 이상 수정되지 않은 문서 찾기
- 수동 검토를 위해 목록
차이 요약 표시

진실의 소스

문서는 다음에서 생성됩니다:

package.json - 스크립트, 설명
.env.example - 환경 변수
코드 주석 - JSDoc, TSDoc

사용 예시


# 문서 업데이트
/update-docs
 
# 출력 예시
## 문서 업데이트
 
### package.json에서 추출
| 스크립트 | 설명 |
|---------|------|
| dev | 개발 서버 실행 |
| build | 프로덕션 빌드 |
| test | 테스트 실행 |
| lint | ESLint 검사 |
 
### .env.example에서 추출
| 변수 | 설명 | 예시 |
|------|------|------|
| DATABASE_URL | DB 연결 문자열 | postgres://... |
| API_KEY | API 인증 키 | sk-... |
 
### 생성된 파일
- docs/CONTRIB.md ✅
- docs/RUNBOOK.md ✅
 
### 오래된 문서 (90일+)
- docs/old-guide.md - 수동 검토 필요
 
## 요약
- 업데이트된 파일: 2
- 오래된 문서: 1

💡

원칙: 단일 진실의 소스. 문서는 항상 코드에서 생성되어야 합니다.