sodalive-backend-spring-boot/docs/agent-guides/문서유지보수.md

문서 유지보수

문서 유지보수 규칙

• PRD 문서와 구현 계획/TASK 문서는 docs/[날짜]_구현할내용한글/ 아래에 함께 둔다.
• 날짜는 YYYYMMDD 8자리 숫자를 사용한다.
• PRD 문서 파일명은 prd.md, 구현 계획/TASK 문서 파일명은 plan-task.md를 사용한다.
• PRD 문서는 sample-prd.md에서 필요한 섹션만 발췌해 작성하고, 불필요한 빈 섹션을 기계적으로 복사하지 않는다.
• sample-prd.md가 없거나 위치가 불명확하면 추측하지 말고 사용자에게 확인한다.
• 구현 계획/TASK 문서는 의미 단위 phase로 나누고 ### Phase 1: ..., ### Phase 2: ... 형식의 heading을 사용한다.
• 각 phase 아래에는 단계별 task를 체크박스(- [ ] **Task N.N: ...**) 형태로 작성한다.
• 각 task에는 구현 시 생성/수정/확인할 파일 경로를 명시한다.
• 각 task에는 TDD 절차를 명시한다. 기본 형식은 RED: 실패 테스트 작성/실패 확인, GREEN: 최소 구현/통과 확인, REFACTOR: 정리/회귀 확인을 포함한다.
• 테스트 작성이 현실적으로 불가능한 task는 TDD 예외 사유와 대체 검증 방법을 task에 명시한다.
• 각 phase 또는 task에는 실행 명령, 기대 결과, 수동 확인 항목 등 검증 기준을 함께 작성한다.
• 각 task의 검증 기준에는 단일 테스트 실행 명령과 필요한 경우 전체 회귀 명령을 포함한다.
• 구현 완료 즉시 해당 task 체크박스를 - [x]로 갱신한다.
• 작업 도중 범위가 변경되면 계획 문서 체크리스트를 먼저 업데이트한 뒤 구현한다.
• 결과 보고 시 문서 하단에 검증 기록(무엇/왜/어떻게, 실행 명령, 결과)을 한국어로 남긴다.
• 후속 수정이 발생해도 기존 검증 기록은 삭제하거나 덮어쓰지 않고 누적한다.
• build.gradle.kts 변경 시 실행 명령 섹션을 함께 갱신한다.
• 테스트 클래스 추가/이동 시 단일 테스트 실행 예시를 최신 상태로 유지한다.
• .editorconfig 변경 시 포맷 규칙 섹션을 동기화한다.
• 연속된 하나의 작업에 대해 PRD 또는 구현 계획/TASK 문서가 여러 개 생기지 않도록 기존 문서 재사용 여부를 먼저 확인한다.
• 문서 변경 후 최소 한 번 ./gradlew tasks --all로 명령 유효성을 확인한다.
• 운영 DB 반영용 DDL 문서는 MySQL 기준으로 작성한다.
• DDL 작성 시 날짜/시간 표시 컬럼은 TIMESTAMP 타입을 사용하고, created_at은 TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '생성 시각', updated_at은 TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '수정 시각' 형식을 기본으로 한다.
• DDL의 모든 컬럼에는 MySQL COMMENT를 추가하고, 테이블에도 가능한 경우 COMMENT를 남긴다.
• 불확실한 규칙은 추측으로 채우지 말고 근거 파일 경로를 먼저 확인한다.
• 에이전트 안내 문구는 한국어 중심으로 유지한다.
• 커밋 규칙 예시는 팀 컨벤션 변경 시 즉시 업데이트한다.