docs(agents): 이슈 추적과 도메인 문서 규칙을 정한다
This commit is contained in:
@@ -160,3 +160,13 @@ Strong success criteria let you loop independently. Weak criteria ("make it work
|
|||||||
## 문서 유지보수 규칙
|
## 문서 유지보수 규칙
|
||||||
- 상세 문서 유지보수 규칙은 `docs/agent-guides/documentation-policy.md`를 참조한다.
|
- 상세 문서 유지보수 규칙은 `docs/agent-guides/documentation-policy.md`를 참조한다.
|
||||||
- `docs/sample/**`의 경로 또는 구조가 바뀌면 `AGENTS.md`, `docs/agent-guides/**`, 샘플 간 참조를 함께 갱신해 서로 일치시킨다.
|
- `docs/sample/**`의 경로 또는 구조가 바뀌면 `AGENTS.md`, `docs/agent-guides/**`, 샘플 간 참조를 함께 갱신해 서로 일치시킨다.
|
||||||
|
|
||||||
|
## Agent skills
|
||||||
|
|
||||||
|
### Issue tracker
|
||||||
|
|
||||||
|
로컬 Markdown으로 `.scratch/<feature-slug>/`에서 이슈를 관리한다. 세부 규칙은 `docs/agents/issue-tracker.md`를 따른다.
|
||||||
|
|
||||||
|
### Domain docs
|
||||||
|
|
||||||
|
single-context 구조로 루트 `GLOSSARY.md`와 `docs/adr/`를 사용한다. 읽기 규칙은 `docs/agents/domain.md`를 따른다.
|
||||||
|
|||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# 도메인 문서
|
||||||
|
|
||||||
|
## 구조와 읽기 순서
|
||||||
|
|
||||||
|
- single-context 구조를 사용한다.
|
||||||
|
- 코드 탐색 전에 루트 `GLOSSARY.md`와 작업 영역에 관련된 `docs/adr/` 문서를 읽는다.
|
||||||
|
- 문서가 없으면 별도 경고나 생성 제안 없이 진행한다.
|
||||||
|
- 용어와 결정이 실제로 정리될 때 `/domain-modeling`으로 필요한 문서를 작성한다.
|
||||||
|
|
||||||
|
## 용어와 결정 준수
|
||||||
|
|
||||||
|
- 이슈 제목, 제안, 가설, 테스트 이름에는 용어집에 정의된 용어를 사용한다.
|
||||||
|
- 용어가 없으면 프로젝트에서 사용하는 표현인지 확인하고, 실제 공백은 `/domain-modeling`의 후속 정리 대상으로 남긴다.
|
||||||
|
- 기존 ADR과 충돌하는 제안은 해당 ADR과 재검토 이유를 명시한다.
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
# 이슈 추적: 로컬 Markdown
|
||||||
|
|
||||||
|
이 저장소의 이슈는 외부 서비스 대신 `.scratch/`의 Markdown 파일로 관리한다.
|
||||||
|
|
||||||
|
## 기본 규칙
|
||||||
|
|
||||||
|
- 기능별 디렉터리: `.scratch/<feature-slug>/`
|
||||||
|
- 스킬이 작성하는 사양: `.scratch/<feature-slug>/spec.md`
|
||||||
|
- 구현 이슈: `.scratch/<feature-slug>/issues/<NN>-<slug>.md`
|
||||||
|
- 이슈 번호는 `01`부터 시작하고, 여러 이슈를 한 파일에 합치지 않는다.
|
||||||
|
- 상태는 각 이슈 상단의 `Status:` 줄에 실행 스킬의 상태 규칙대로 기록한다.
|
||||||
|
- 댓글과 대화는 파일 하단의 `## Comments`에 누적한다.
|
||||||
|
- 구현용 PRD와 계획/TASK 문서는 기존 `docs/agent-guides/documentation-policy.md`를 따른다.
|
||||||
|
- 기존 PRD나 계획이 있으면 사양과 이슈에서 해당 문서를 참조하고 내용을 중복 관리하지 않는다.
|
||||||
|
|
||||||
|
## 스킬 요청 해석
|
||||||
|
|
||||||
|
- 이슈 추적기에 게시: 위 경로에 Markdown 파일을 생성한다.
|
||||||
|
- 관련 티켓 조회: 전달받은 경로나 기능 내 이슈 번호에 해당하는 파일을 읽는다.
|
||||||
|
|
||||||
|
## Wayfinding 작업 규칙
|
||||||
|
|
||||||
|
- 지도: `.scratch/<effort>/map.md`에 Notes, Decisions-so-far, Fog를 기록한다.
|
||||||
|
- 하위 티켓: `issues/NN-<slug>.md`에 질문과 `Type:`을 기록한다.
|
||||||
|
- 유형: `research`, `prototype`, `grilling`, `task`.
|
||||||
|
- 차단 관계: 상단의 `Blocked by: NN, NN`에 기록한다. 모든 선행 티켓이 `resolved`이면 차단이 해제된다.
|
||||||
|
- 다음 작업: 미해결·차단 해제·미점유 티켓 중 번호가 가장 작은 것을 선택한다.
|
||||||
|
- 점유: 작업 시작 전에 `Status: claimed`를 기록한다.
|
||||||
|
- 해결: `## Answer`에 답을 누적하고 `Status: resolved`로 변경한 뒤, 지도 Decisions-so-far에 요약과 링크를 추가한다.
|
||||||
Reference in New Issue
Block a user