docs: cli 용 문서 업로드 (runbook: 개발, runbook_planner: 기획)
This commit is contained in:
20
.cli/ops/archive_current.md
Normal file
20
.cli/ops/archive_current.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# .cli/ops/archive_current.md
|
||||
|
||||
## 목적
|
||||
|
||||
- `.cli/current.md`의 전체 내용을 스냅샷으로 tasks 폴더에 저장한다.
|
||||
- task 파일의 내용은 “이번 작업에 사용된 current.md 전체 내용”과 동일해야 한다.
|
||||
|
||||
## 입력
|
||||
|
||||
- `.cli/_task_context.md`에서 아래를 읽는다:
|
||||
- TASK_ID
|
||||
- TASK_SLUG
|
||||
|
||||
## 절차
|
||||
|
||||
1. `.cli/tasks/` 폴더가 없으면 생성한다.
|
||||
2. 아카이브 파일 경로를 만든다:
|
||||
- `.cli/tasks/{TASK_ID}-{TASK_SLUG}.md`
|
||||
3. `.cli/current.md`의 전체 내용을 위 파일에 그대로 저장한다.
|
||||
4. 저장된 파일이 존재하는지 확인한다.
|
||||
40
.cli/ops/issue_task_id.md
Normal file
40
.cli/ops/issue_task_id.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# .cli/ops/issue_task_id.md
|
||||
|
||||
## 목적
|
||||
|
||||
- 다음 TASK_ID를 발급하고,
|
||||
- ops 간 공유 컨텍스트 파일 `.cli/_task_context.md`를 생성/갱신한다.
|
||||
|
||||
## 입력
|
||||
|
||||
- `.cli/current.md`의 `TASK_META`에서 아래를 읽는다:
|
||||
- TASK_TITLE
|
||||
- TASK_SLUG
|
||||
|
||||
## 절차
|
||||
|
||||
1. `.cli/tasks/` 폴더가 없으면 생성한다.
|
||||
2. `.cli/tasks/` 내 파일명 중 `^\d{4}-` 패턴(예: `0007-...`)을 가진 파일들을 찾는다.
|
||||
3. 존재하면 가장 큰 4자리 번호를 TASK_ID_MAX로 두고, TASK_ID = TASK_ID_MAX + 1
|
||||
4. 아무 파일도 없으면 TASK_ID = `0001`
|
||||
5. TASK_ID는 4자리 zero-pad 유지(예: 0007)
|
||||
|
||||
## 날짜(DATE)
|
||||
|
||||
- DATE는 `YYYY-MM-DD` 형식으로 기록한다.
|
||||
|
||||
## 수정 파일 목록(FILES)
|
||||
|
||||
- 가능한 경우 `git status --porcelain`로 수정 파일 경로를 수집한다.
|
||||
- git을 사용할 수 없으면, 최소한 이번 작업의 주요 파일을 나열한다(예: `src/app/page.tsx`).
|
||||
- FILES는 쉼표로 구분된 문자열로 기록한다.
|
||||
|
||||
## 출력 파일(컨텍스트) — 고정 포맷
|
||||
|
||||
아래 형식으로 `.cli/_task_context.md`를 생성/덮어쓴다(포맷 변경 금지):
|
||||
|
||||
- TASK_ID: ####
|
||||
- TASK_TITLE: ...
|
||||
- TASK_SLUG: ...
|
||||
- DATE: YYYY-MM-DD
|
||||
- FILES: path1, path2
|
||||
14
.cli/ops/reset_current.md
Normal file
14
.cli/ops/reset_current.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# .cli/ops/reset_current.md
|
||||
|
||||
## 목적
|
||||
|
||||
- `.cli/current.md`를 다음 작업을 위해 비운다.
|
||||
|
||||
## 절차
|
||||
|
||||
- `.cli/current.md`의 내용을 아래 한 줄로 교체한다:
|
||||
- `# .cli/current.md (empty)`
|
||||
|
||||
## 출력(없음)
|
||||
|
||||
- 별도 출력하지 않는다. (run_housekeeping이 최종 1줄 출력)
|
||||
19
.cli/ops/run_housekeeping.md
Normal file
19
.cli/ops/run_housekeeping.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# .cli/run_housekeeping.md
|
||||
|
||||
## 목적
|
||||
|
||||
작업 종료 후 정리 절차를 수행한다.
|
||||
|
||||
## 실행 순서(필수)
|
||||
|
||||
아래 문서들을 순서대로 수행하라:
|
||||
|
||||
1. `@.cli/ops/issue_task_id.md`
|
||||
2. `@.cli/ops/archive_current.md`
|
||||
3. `@.cli/ops/update_changelog.md`
|
||||
4. `@.cli/ops/reset_current.md`
|
||||
|
||||
## 출력(최소)
|
||||
|
||||
마지막에 아래 1줄만 출력하라:
|
||||
`HOUSEKEEPING | task_id=<####> | archived=OK | changelog=OK | current=reset`
|
||||
50
.cli/ops/update_changelog.md
Normal file
50
.cli/ops/update_changelog.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# .cli/ops/update_changelog.md
|
||||
|
||||
## 목적
|
||||
|
||||
- `.cli/changelog.md`에 이번 작업 항목을 “최신이 위”가 되도록 추가한다.
|
||||
|
||||
## 입력
|
||||
|
||||
- `.cli/_task_context.md`에서 아래를 읽는다:
|
||||
- TASK_ID
|
||||
- TASK_TITLE
|
||||
- DATE
|
||||
- FILES
|
||||
|
||||
## 준비
|
||||
|
||||
- `.cli/changelog.md`가 없으면 아래 템플릿으로 생성한다(그대로 복사).
|
||||
|
||||
### changelog 초기 템플릿(파일 생성 시)
|
||||
|
||||
# Changelog
|
||||
|
||||
> 규칙
|
||||
>
|
||||
> - 새 작업이 끝나면 맨 위(최신)에 추가한다.
|
||||
> - 날짜 섹션이 없으면 새로 만든다.
|
||||
> - 각 항목은 3~5줄 이내로 짧게.
|
||||
> - “무엇이 바뀌었는지”와 “영향 범위(파일)”만 남긴다.
|
||||
|
||||
## YYYY-MM-DD
|
||||
|
||||
- [0001] 작업 제목(짧게)
|
||||
- Summary: 변경 요약 1
|
||||
- Summary: 변경 요약 2
|
||||
- Files: path1, path2
|
||||
|
||||
## 추가 규칙
|
||||
|
||||
1. `## {DATE}` 섹션이 있으면, 그 섹션 **바로 아래 최상단**에 항목을 추가한다.
|
||||
2. `## {DATE}` 섹션이 없으면, 파일 맨 위(헤더/규칙 블록 다음)에 새로 만들고 그 아래에 추가한다.
|
||||
3. Summary는 2줄(최대 3줄)로 짧게 작성한다.
|
||||
4. Files는 컨텍스트의 `FILES`를 그대로 기록한다.
|
||||
|
||||
## 추가 항목 템플릿(이 포맷 유지)
|
||||
|
||||
- [{TASK_ID}] {TASK_TITLE}
|
||||
- Summary: (변경 요약 1줄)
|
||||
- Summary: (변경 요약 1줄)
|
||||
- Summary: (선택)
|
||||
- Files: {FILES}
|
||||
Reference in New Issue
Block a user