76 lines
2.5 KiB
Markdown
76 lines
2.5 KiB
Markdown
# PRD: 작업 계획 문서 규칙과 커밋 메시지 규칙 분리
|
|
|
|
## 1. Overview
|
|
`docs/agent-guides/workflow-docs-commits.md`에 혼재된 작업 계획 문서 규칙과 커밋 메시지 규칙을 별도 문서로 분리한다.
|
|
|
|
---
|
|
|
|
## 2. Problem
|
|
- 하나의 문서에 작업 계획 문서 규칙과 커밋 메시지 규칙이 함께 있어 필요한 규칙을 찾기 어렵다.
|
|
- `AGENTS.md`의 참조도 두 규칙을 하나의 항목으로 안내해 책임 범위가 불명확하다.
|
|
- 기존 문서 경로를 유지하면 canonical 문서가 늘어나 혼선을 줄 수 있다.
|
|
|
|
---
|
|
|
|
## 3. Goals
|
|
- 작업 계획 문서 규칙과 커밋 메시지 규칙을 각각 독립 문서로 분리한다.
|
|
- `AGENTS.md`가 분리된 문서를 직접 참조하도록 갱신한다.
|
|
- 기존 `workflow-docs-commits.md`는 삭제해 새 문서 2개만 canonical 문서로 유지한다.
|
|
|
|
---
|
|
|
|
## 4. Non-Goals
|
|
- 과거 `docs/plan-task/*.md` 검증 기록을 일괄 수정하지 않는다.
|
|
- 커밋 메시지 규칙 자체를 변경하지 않는다.
|
|
- 작업 계획 문서 규칙 자체를 변경하지 않는다.
|
|
|
|
---
|
|
|
|
## 5. Target Users
|
|
- 이 저장소에서 작업하는 에이전트와 개발자.
|
|
|
|
---
|
|
|
|
## 6. User Stories
|
|
- 사용자는 작업 계획 문서 작성 규칙만 빠르게 확인하고 싶다.
|
|
- 사용자는 커밋 메시지 규칙만 별도 문서에서 확인하고 싶다.
|
|
- 사용자는 `AGENTS.md`에서 두 규칙의 canonical 문서를 명확히 찾고 싶다.
|
|
|
|
---
|
|
|
|
## 7. Core Features
|
|
|
|
### 규칙 문서 분리
|
|
|
|
#### Requirements
|
|
- 작업 계획 문서 규칙은 `docs/agent-guides/work-plan-docs.md`로 분리한다.
|
|
- 커밋 메시지 규칙은 `docs/agent-guides/commit-message-rules.md`로 분리한다.
|
|
- 기존 `docs/agent-guides/workflow-docs-commits.md`는 삭제한다.
|
|
- `AGENTS.md` 상세 참조 문서 항목은 분리된 문서를 직접 가리킨다.
|
|
|
|
#### Edge Cases
|
|
- 과거 계획 문서에 남은 `workflow-docs-commits.md` 참조는 당시 검증 기록이므로 일괄 수정하지 않는다.
|
|
- 같은 규칙 본문이 여러 문서에 중복되지 않도록 한다.
|
|
|
|
---
|
|
|
|
## 8. UX / UI Expectations
|
|
- 해당 없음.
|
|
|
|
---
|
|
|
|
## 9. Technical Constraints
|
|
- Markdown 문서만 수정한다.
|
|
- 변경 범위는 `AGENTS.md`, `docs/agent-guides/`, 신규 PRD/계획 문서로 제한한다.
|
|
|
|
---
|
|
|
|
## 10. Metrics
|
|
- `AGENTS.md`가 `work-plan-docs.md`와 `commit-message-rules.md`를 모두 참조한다.
|
|
- `docs/agent-guides/workflow-docs-commits.md` 파일이 남아 있지 않다.
|
|
|
|
---
|
|
|
|
## 11. Open Questions
|
|
- 없음.
|