docs(workflow): 작업 계획 커밋 규칙 분리를 계획한다
This commit is contained in:
57
docs/plan-task/20260527_작업계획커밋규칙분리.md
Normal file
57
docs/plan-task/20260527_작업계획커밋규칙분리.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# 20260527 작업 계획 커밋 규칙 분리
|
||||
|
||||
## 개요
|
||||
- `docs/agent-guides/workflow-docs-commits.md`에 혼재된 작업 계획 문서 규칙과 커밋 메시지 규칙을 분리한다.
|
||||
- PRD: `docs/prd/20260527_작업계획커밋규칙분리_prd.md`
|
||||
|
||||
## 작업 체크리스트
|
||||
- [x] 기존 `workflow-docs-commits.md`와 `AGENTS.md` 참조를 확인한다.
|
||||
- [x] 작업 계획 문서 규칙을 `docs/agent-guides/work-plan-docs.md`로 분리한다.
|
||||
- [x] 커밋 메시지 규칙을 `docs/agent-guides/commit-message-rules.md`로 분리한다.
|
||||
- [x] 기존 `workflow-docs-commits.md`를 삭제한다.
|
||||
- [x] `AGENTS.md` 상세 참조 문서를 분리된 문서 기준으로 갱신한다.
|
||||
- [x] `rg`와 `git diff`로 참조와 변경 범위를 검증한다.
|
||||
|
||||
## 구현 범위
|
||||
- Add: `docs/prd/20260527_작업계획커밋규칙분리_prd.md`
|
||||
- Add: `docs/plan-task/20260527_작업계획커밋규칙분리.md`
|
||||
- Add: `docs/agent-guides/work-plan-docs.md`
|
||||
- Add: `docs/agent-guides/commit-message-rules.md`
|
||||
- Delete: `docs/agent-guides/workflow-docs-commits.md`
|
||||
- Modify: `AGENTS.md`
|
||||
|
||||
## 검증 기록
|
||||
- 2026-05-27
|
||||
- 무엇/왜/어떻게: 사용자 요청에 따라 혼재된 작업 계획 문서 규칙과 커밋 메시지 규칙을 분리하기 위해 기존 문서와 `AGENTS.md` 참조를 확인하고, 기존 경로는 과거 참조 호환을 위해 처음에는 인덱스로 유지했다.
|
||||
- 실행 명령/도구:
|
||||
- `read(docs/agent-guides/workflow-docs-commits.md)`
|
||||
- `read(AGENTS.md)`
|
||||
- `rg -n "workflow-docs-commits|커밋 메시지|작업 계획 문서|plan-task|docs/prd" .`
|
||||
- `task(subagent_type="plan")`
|
||||
- 결과:
|
||||
- `workflow-docs-commits.md`가 작업 계획 문서 규칙과 커밋 메시지 규칙을 함께 담고 있음을 확인했다.
|
||||
- `AGENTS.md`의 상세 참조 문서 항목이 통합 문서 하나만 가리키고 있음을 확인했다.
|
||||
|
||||
- 2026-05-27
|
||||
- 무엇/왜/어떻게: 분리된 문서 경로와 헤딩이 의도대로 배치됐는지 확인하고, 기존 `workflow-docs-commits.md`가 상세 규칙 대신 인덱스로만 남았는지 검증했다.
|
||||
- 실행 명령/도구:
|
||||
- `rg -n "workflow-docs-commits.md|work-plan-docs.md|commit-message-rules.md" AGENTS.md docs/agent-guides docs/plan-task/20260527_작업계획커밋규칙분리.md`
|
||||
- `rg -n "커밋 메시지 규칙|작업 계획 문서 규칙|작업 절차 체크리스트|문서 유지보수 규칙" docs/agent-guides`
|
||||
- `git diff -- AGENTS.md docs/agent-guides/workflow-docs-commits.md`
|
||||
- `read(docs/agent-guides/work-plan-docs.md)`
|
||||
- `read(docs/agent-guides/commit-message-rules.md)`
|
||||
- `read(docs/agent-guides/workflow-docs-commits.md)`
|
||||
- `read(AGENTS.md)`
|
||||
- 결과:
|
||||
- `AGENTS.md`가 `docs/agent-guides/work-plan-docs.md`와 `docs/agent-guides/commit-message-rules.md`를 직접 참조함을 확인했다.
|
||||
- `workflow-docs-commits.md`는 두 분리 문서 링크만 담은 호환용 인덱스로 축소됐음을 확인했다.
|
||||
- 과거 `docs/plan-task` 로그는 일괄 수정하지 않았다.
|
||||
|
||||
- 2026-05-27
|
||||
- 무엇/왜/어떻게: 사용자가 호환용 인덱스 제거를 승인해 `workflow-docs-commits.md`를 삭제 대상으로 변경하고 PRD/계획 문서의 목표와 구현 범위를 삭제 기준으로 갱신했다.
|
||||
- 실행 명령/도구:
|
||||
- `read(docs/prd/20260527_작업계획커밋규칙분리_prd.md)`
|
||||
- `read(docs/plan-task/20260527_작업계획커밋규칙분리.md)`
|
||||
- 결과:
|
||||
- 신규 canonical 문서는 `work-plan-docs.md`, `commit-message-rules.md` 두 개로 고정했다.
|
||||
- 기존 `workflow-docs-commits.md`는 삭제하기로 결정했다.
|
||||
75
docs/prd/20260527_작업계획커밋규칙분리_prd.md
Normal file
75
docs/prd/20260527_작업계획커밋규칙분리_prd.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# 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
|
||||
- 없음.
|
||||
Reference in New Issue
Block a user