docs(agent): 에이전트 문서 규칙을 정리한다

This commit is contained in:
2026-05-29 13:58:54 +09:00
parent ddac78a666
commit b07f2d9646
9 changed files with 132 additions and 171 deletions

View File

@@ -9,14 +9,18 @@
- 기존 `AGENTS.md`는 작업 계획 문서 작성만 요구하고 있어 PRD 작성과 사용자 인터뷰 흐름이 명확하지 않다.
- 계획 문서 저장 위치가 `docs`로 넓게 표현되어 있어 현재 저장 구조인 `docs/plan-task/`와 완전히 일치하지 않는다.
- PRD 문서 작성 시 `docs/prd/sample-prd.md`에서 필요한 섹션을 발췌한다는 기준이 연결 문서에 명시되어 있지 않다.
- 후속 요구사항 기준으로 PRD와 계획/TASK 문서를 같은 작업 폴더에 두는 새 구조가 필요하다.
- 실행 명령어와 커밋 메시지 규칙이 `AGENTS.md` 본문에 직접 포함되어 있어 상세 가이드 분리가 필요하다.
---
## 3. Goals
- 구현 전 필수 문서 순서를 `PRD -> 계획 TASK -> 최소 구현`으로 고정한다.
- PRD 문서 저장 위치를 `docs/prd/`, 계획 TASK 문서 저장 위치를 `docs/plan-task/`로 명확히 한다.
- PRD 파일명은 기존 계획 문서 파일명 규칙을 따르되 계획 문서와 구분되도록 한다.
- PRD와 구현 계획/TASK 문서 저장 위치를 `docs/[날짜]_구현할내용한글/`로 명확히 한다.
- PRD 파일명은 `prd.md`, 구현 계획/TASK 파일명은 `plan-task.md`로 고정한다.
- 애매한 요구사항은 PRD 단계에서 사용자 인터뷰를 반복해 해소하도록 명시한다.
- 구현 계획/TASK 문서의 phase, task 체크박스, 파일 경로, 검증 기준, 검증 기록 누적 규칙을 명확히 한다.
- 실행 명령어와 커밋 메시지 규칙을 별도 `docs/agent-guides/` 문서로 분리한다.
---
@@ -41,16 +45,37 @@
### 문서 저장 위치와 파일명 규칙
#### Requirements
- PRD 문서`docs/prd/` 작성한다.
- 계획 TASK 문서는 `docs/plan-task/`에 작성한다.
- PRD 문서 파일명은 `[날짜]_구현할내용한글_prd.md`처럼 기존 계획 문서 규칙과 구분되는 접미사를 사용한다.
- 계획 TASK 문서 파일명은 기존 `[날짜]_구현할내용한글.md` 규칙을 유지한다.
- PRD 문서와 구현 계획/TASK 문서는 `docs/[날짜]_구현할내용한글/` 아래에 함께 작성한다.
- PRD 문서 파일명은 `prd.md`를 사용한다.
- 구현 계획/TASK 문서 파일명은 `plan-task.md`를 사용한다.
- 날짜는 `YYYYMMDD` 8자리 숫자를 사용한다.
- `sample-prd.md`가 없거나 위치가 불명확하면 추측하지 말고 사용자에게 확인한다.
### 구현 계획/TASK 문서 형식
#### Requirements
- 계획/TASK 문서는 의미 단위 phase로 나누고 `### Phase 1: ...`, `### Phase 2: ...` 형식의 heading을 사용한다.
- 각 phase 아래에는 단계별 task를 체크박스(`- [ ] **Task N.N: ...**`) 형태로 작성한다.
- 각 task에는 구현 시 생성/수정/확인할 파일 경로를 명시한다.
- 각 phase 또는 task에는 실행 명령, 기대 결과, 수동 확인 항목 등 검증 기준을 함께 작성한다.
- 작업 도중 범위가 변경되면 계획 문서 체크리스트를 먼저 업데이트한 뒤 구현한다.
- 구현 완료 즉시 체크박스를 `- [x]`로 갱신한다.
- 결과 보고 시 문서 하단에 검증 기록(무엇/왜/어떻게, 실행 명령, 결과)을 한국어로 남긴다.
- 후속 수정이 발생해도 기존 검증 기록은 삭제하거나 덮어쓰지 않고 누적한다.
### 상세 가이드 분리
#### Requirements
- 실행 명령어는 `docs/agent-guides/실행명령어.md`로 분리한다.
- 커밋 메시지 규칙은 `docs/agent-guides/커밋메시지.md`로 분리한다.
- `AGENTS.md`는 새 가이드 파일을 링크하고 상세 규칙 중복을 줄인다.
---
## 9. Technical Constraints
- `AGENTS.md``docs/agent-guides/작업절차.md`, `docs/agent-guides/문서유지보수.md`의 표현을 일치시킨다.
- 기존 문서 구조와 한국어 안내 원칙을 유지한다.
- 기존 사용자 변경으로 보이는 파일 삭제나 문서 수정은 되돌리지 않는다.
---