본문으로 건너뛰기

update-docs

문서 업데이트 (Update Documentation)

진실의 원천(source-of-truth)으로부터 문서를 동기화합니다:

  1. package.json 스크립트 섹션 읽기

    • 스크립트 참조 테이블 생성
    • 주석에서 설명 포함
  2. .env.example 읽기

    • 모든 환경 변수 추출
    • 목적 및 형식 문서화
  3. docs/CONTRIB.md 생성:

    • 개발 워크플로우
    • 사용 가능한 스크립트
    • 환경 설정
    • 테스팅 절차
  4. docs/RUNBOOK.md 생성:

    • 배포 절차
    • 모니터링 및 알림
    • 일반적인 문제 및 해결법
    • 롤백 절차
  5. 오래된 문서 식별:

    • 90일 이상 수정되지 않은 문서 찾기
    • 수동 검토를 위해 목록화
  6. 차이(diff) 요약 표시

단일 진실 공급원: package.json 및 .env.example