Files
sodalive-ios/docs/agent-guides/documentation-policy.md

1.8 KiB

문서 작성 및 유지보수 정책

SodaLive 저장소에서 에이전트가 작업 계획 문서와 가이드 문서를 작성, 갱신, 검증할 때 따르는 규칙이다.

작업 계획 문서 규칙

  • 모든 작업 시작 전에 docs 폴더 아래 계획 문서를 먼저 생성하고, 해당 문서를 기준으로 구현한다.
  • 계획 문서 파일명은 [날짜]_구현할내용한글.md 형식을 사용한다.
  • 날짜는 YYYYMMDD 8자리 숫자를 사용한다.
  • 구현 항목은 기능/작업 단위 체크박스(- [ ])로 작성하고 완료 즉시 - [x]로 갱신한다.
  • 작업 도중 범위가 변경되면 계획 문서 체크리스트를 먼저 업데이트한 뒤 구현한다.
  • 결과 보고 시 문서 하단에 검증 기록(무엇/왜/어떻게, 실행 명령, 결과)을 한국어로 남긴다.
  • 후속 수정이 발생해도 기존 검증 기록은 삭제/덮어쓰기 없이 누적한다.

문서 유지보수 규칙

  • 불확실한 규칙은 추측으로 채우지 말고 근거 파일 경로를 먼저 확인한다.
  • 에이전트 안내 문구는 한국어 중심으로 유지한다.
  • CORE EXECUTION PRINCIPLES (andrej-karpathy-skills) 섹션은 공식 원문을 영어로 유지한다.
  • 명령/경로/타깃명이 바뀌면 AGENTS.mddocs/agent-guides/**를 즉시 업데이트한다.

문서 분리 기준

  • AGENTS.md에는 실행 판단에 필요한 핵심 정책과 참조 경로만 남긴다.
  • 빌드/테스트/검증 명령은 docs/agent-guides/build-test-verification.md에 둔다.
  • 코드 스타일 규칙은 docs/agent-guides/code-style.md에 둔다.
  • 에이전트 실행 정책 상세는 docs/agent-guides/agent-execution-policy.md에 둔다.
  • 문서 작성 및 유지보수 규칙은 이 문서에 둔다.