klaus/sodalive-ios
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(agent): 문서 샘플 기준을 정리한다

Browse Source
This commit is contained in:
Yu Sung
2026-07-30 14:30:32 +09:00
parent a0db58e53f
commit 0232cd4335
6 changed files with 807 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
AGENTS.md
View File

@@ -151,8 +151,12 @@ Strong success criteria let you loop independently. Weak criteria ("make it work
## 문서 작성 규칙
- 구현 전 PRD 작성, 사용자 인터뷰, 계획/TASK 문서 작성, 체크리스트 갱신, 검증 기록 누적, 문서 분리 기준은 `docs/agent-guides/documentation-policy.md`를 따른다.
- 신규 PRD, 계획/TASK 문서, 코드 리뷰 리포트를 만들기 전에 각각 `docs/sample/sample-prd.md`, `docs/sample/sample-plan-task.md`, `docs/sample/sample-review.md`를 확인하고 현재 샘플 구조를 따른다.
- 연속된 하나의 작업은 새 문서를 만들지 말고 기존 PRD와 `plan-task.md`에 이어서 기록한다.
- 계획/TASK 문서는 phase heading(`### Phase N: ...`)과 단계별 체크박스(`- [ ] **Task N.N: ...**`)를 사용하고, 각 task에는 대상 파일 경로와 검증 기준을 함께 적는다.
- 계획/TASK 문서는 `sample-plan-task.md`의 Phase, Task, Goal, 완료 증거, 검증 기록 구조를 따르고 각 Task에 대상 파일 경로와 검증 기준을 적는다.
- 코드 리뷰와 점검 결과는 PRD 및 `plan-task.md`와 같은 작업 디렉터리의 `reviews/` 아래에 `phase<번호>-<구현 내용을 나타내는 영문 kebab-case>.md` 형식의 리포트로 남긴다.
- 리뷰에서 수정이 필요하다고 확정한 항목은 코드 수정 전에 `plan-task.md`의 해당 Phase에 실행 가능한 신규 Task로 추가하고, 그 Task를 기준으로 수정 및 검증한다.
## 문서 유지보수 규칙
- 상세 문서 유지보수 규칙은 `docs/agent-guides/documentation-policy.md`를 참조한다.
- `docs/sample/**`의 경로 또는 구조가 바뀌면 `AGENTS.md`, `docs/agent-guides/**`, 샘플 간 참조를 함께 갱신해 서로 일치시킨다.