Operations

문서 유지보수 + 세션 이어가기

Documentation and session rules for keeping project context aligned.

문서 유지보수 원칙

  • 세션 시작 시 CLAUDE.md와 실제 코드 구조를 대조하고, 낡은 내용이 있으면 즉시 갱신한다.
  • 파일/폴더 추가, 삭제, 이동이 있으면 관련 경로와 구조 설명을 함께 갱신한다.
  • 삭제된 기능이나 파일에 대한 죽은 참조를 남기지 않는다.
  • GitHub Pages 공개 문서는 docs/를 기준으로 한다.
  • 제품 운영 문서, 아키텍처 결정, API 성격의 설명은 별도 API 문서 트리를 만들지 않고 docs/skills/의 identity/architecture/ops 문서로 관리한다.
  • 공개 글쓰기와 블로그성 콘텐츠는 루트 blog/가 아니라 docs/blog/에 둔다. 공개 URL도 /docs/blog/...를 기준으로 한다.
  • docs/ 하위의 장기 유지 폴더는 docs/skills/docs/blog/ 두 개만 둔다.
  • concepts, guides, reference, getting-started, branding 같은 폴더가 필요해지면 새 폴더를 만들기 전에 docs/skills/에 흡수한다.
  • 기존 문서를 제거해야 할 때는 먼저 docs/skills/ 또는 docs/blog/에 흡수됐는지 확인하고, 사용자가 보관을 요구하지 않으면 삭제한다.

세션 이어가기 원칙

  • 세션이 끝나도 다음 세션이 채팅 없이 바로 이어갈 수 있게 현재 결정, 진행 상태, 다음 액션, 남은 검증을 반드시 저장소 문서에 남긴다.
  • 중간 상태의 TODO, blocker, diff는 채팅이 아니라 관련 기능 문서의 체크리스트로 남긴다.
  • 작업이 여러 세션에 걸리면 가장 가까운 docs/skills/{category}/README.md (또는 해당 모듈의 SKILL 파일)에 최소한 Current State, Next Action, Verification Left를 갱신한다.
  • 다음 세션은 먼저 프로젝트 메모리, 그다음 관련 기능 문서, 마지막으로 직전 수정 파일을 읽고 시작한다.
  • 채팅 기록만 믿고 이어가지 않는다. 설계 결정과 남은 작업은 반드시 저장소 안 문서로 고정한다.
  • 코드 변경이 있었는데 문서가 업데이트되지 않았다면 세션 종료 전에 문서를 먼저 맞춘다.
  • CLAUDE.md가 로컬 규칙의 SSOT이고, AGENTS.mdCLAUDE.md를 먼저 읽으라는 진입점 포인터로 둔다.
  • AGENTS.md 포인터 검사는 uv run python -X utf8 docs/skills/ops/tools/syncAgentsMd.py --check로 수행한다.