From 90003f6ce1345fe932e5db89e8d7d8686d3dad7b Mon Sep 17 00:00:00 2001 From: Yu Sung Date: Tue, 2 Jun 2026 12:07:03 +0900 Subject: [PATCH] =?UTF-8?q?docs(policy):=20=EB=AC=B8=EC=84=9C=20=EC=9E=91?= =?UTF-8?q?=EC=84=B1=20=EA=B7=9C=EC=B9=99=EC=9D=84=20=EB=B3=80=EA=B2=BD?= =?UTF-8?q?=ED=95=9C=EB=8B=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/agent-guides/documentation-policy.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/agent-guides/documentation-policy.md b/docs/agent-guides/documentation-policy.md index 81235d8..5d0c082 100644 --- a/docs/agent-guides/documentation-policy.md +++ b/docs/agent-guides/documentation-policy.md @@ -10,15 +10,17 @@ - 문서 작성 자체, 커밋, 단순 조회처럼 구현을 수반하지 않는 작업은 필요한 최소 문서만 작성한다. ## PRD 문서 규칙 -- PRD 문서는 `docs/prd/` 아래에 작성한다. -- PRD 문서 파일명은 기존 계획 문서 파일명 규칙을 따르되 계획/TASK 문서와 구분되도록 `[날짜]_구현할내용한글_PRD.md` 형식을 사용한다. +- PRD 문서는 `docs/[날짜]_구현할내용한글/prd.md`로 작성한다. +- 문서 폴더명은 `[날짜]_구현할내용한글` 형식을 사용한다. +- 문서 폴더명에서 원래 띄어쓰기가 들어갈 위치는 공백 대신 `_`를 사용한다. +- 이 경로 규칙은 신규 작성 문서부터 적용하며, 기존 과거 문서는 이동하거나 변경하지 않는다. - 날짜는 `YYYYMMDD` 8자리 숫자를 사용한다. - PRD 문서는 `docs/prd/sample-prd.md`에서 필요한 섹션만 발췌해 작성한다. - PRD에는 최소한 목표, 문제/배경, 성공 기준, 제외 범위, 핵심 요구사항, 기술/운영 제약, 미결정 사항을 포함한다. 해당 없는 항목은 억지로 채우지 않고 제외하거나 `해당 없음`으로 명시한다. ## 계획/TASK 문서 규칙 -- 계획/TASK 문서는 `docs/plan-task/` 아래에 작성한다. -- 계획/TASK 문서 파일명은 `[날짜]_구현할내용한글.md` 형식을 사용한다. +- 계획/TASK 문서는 PRD와 같은 문서 폴더 아래에 `plan-task.md`로 작성한다. +- 계획/TASK 문서 경로는 `docs/[날짜]_구현할내용한글/plan-task.md` 형식을 사용한다. - 날짜는 `YYYYMMDD` 8자리 숫자를 사용한다. - 계획/TASK 문서는 보강 완료된 PRD를 기준으로 작성하고, 구현 범위가 PRD의 성공 기준과 제외 범위를 벗어나지 않게 한다. - 구현 항목은 기능/작업 단위 체크박스(`- [ ]`)로 작성하고 완료 즉시 `- [x]`로 갱신한다.