lee-spec-kit 0.6.39 → 0.6.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +303 -146
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/templates/en/common/README.md +2 -0
- package/templates/en/common/features/README.md +1 -0
- package/templates/en/common/features/feature-base/spec.md +2 -0
- package/templates/en/common/features/feature-base/tasks.md +4 -0
- package/templates/en/common/ideas/README.md +1 -0
- package/templates/en/common/prd/README.md +2 -0
- package/templates/ko/common/README.md +2 -0
- package/templates/ko/common/features/README.md +1 -0
- package/templates/ko/common/features/feature-base/spec.md +2 -0
- package/templates/ko/common/features/feature-base/tasks.md +4 -0
- package/templates/ko/common/ideas/README.md +1 -0
- package/templates/ko/common/prd/README.md +2 -0
package/package.json
CHANGED
|
@@ -45,12 +45,14 @@ To avoid ambiguity, treat the following as the single source of truth (SSOT).
|
|
|
45
45
|
- **PRD (`docs/prd/`)**: requirements SSOT
|
|
46
46
|
- Assign stable IDs per requirement: `PRD-FR-001`, `PRD-US-002`, `PRD-NFR-003`
|
|
47
47
|
- Keep IDs stable (prefer marking as Deprecated over deleting; do not renumber).
|
|
48
|
+
- Define PRD IDs in the PRD source first. Do not invent them inside feature docs.
|
|
48
49
|
- **Ideas (`docs/ideas/`)**: pre-Feature SSOT (hypotheses/experiments/candidates)
|
|
49
50
|
- Put `PRD Refs:` at the top (example: `PRD-FR-001, PRD-US-002`).
|
|
50
51
|
- Once promoted, the SSOT moves to `docs/features/` and the idea should be archived.
|
|
51
52
|
- **Features (`docs/features/`)**: implementation scope/progress SSOT
|
|
52
53
|
- `spec.md`: scope + `PRD Refs` (the PRD IDs this feature covers)
|
|
53
54
|
- `tasks.md`: map each task line to PRD IDs via bracket tags like `[PRD-FR-001]`, or tag non-PRD tasks as `[NON-PRD]`
|
|
55
|
+
- For legacy docs without PRD IDs yet, backfill the source requirements doc first, then link the feature docs.
|
|
54
56
|
- `decisions.md`: record changes/trade-offs/requirement changes (why it changed) with evidence links
|
|
55
57
|
|
|
56
58
|
## Change Protocol (When Requirements/Scope Change Mid-Work)
|
|
@@ -64,6 +64,7 @@ npx lee-spec-kit status --write
|
|
|
64
64
|
|
|
65
65
|
- Assign stable requirement IDs in PRD docs (`docs/prd/*.md`) like `PRD-FR-001`.
|
|
66
66
|
- Link each task line in `tasks.md` with a tag like `[PRD-FR-001]`. For non-PRD tasks, use `[NON-PRD]`.
|
|
67
|
+
- Do not invent PRD IDs inside feature docs. Define them in the PRD source first, and backfill legacy docs before linking tasks.
|
|
67
68
|
- Coverage report: `npx lee-spec-kit requirements` (alias: `npx lee-spec-kit prd`)
|
|
68
69
|
|
|
69
70
|
---
|
|
@@ -56,4 +56,6 @@
|
|
|
56
56
|
|
|
57
57
|
- PRD: `../../prd/`
|
|
58
58
|
- PRD Refs: - (e.g. `PRD-FR-001`, `PRD-US-002`)
|
|
59
|
+
- Only list IDs that already exist in the source requirements doc. Do not invent PRD IDs in `spec.md` or `tasks.md`.
|
|
60
|
+
- If this is a legacy requirements doc without PRD IDs yet, backfill IDs in the source first, then update this field and the `tasks.md` task tags together.
|
|
59
61
|
- When requirements/scope change, update PRD docs + this field + `tasks.md` task tags together.
|
|
@@ -8,6 +8,8 @@
|
|
|
8
8
|
- `[DOING] → [DONE]`: share result/verification first + user approval (OK)
|
|
9
9
|
- **Priority**: P0(urgent) > P1(high) > P2(medium) > P3(low)
|
|
10
10
|
- **PRD mapping (recommended)**: add a PRD requirement ID tag like `[PRD-FR-001]` to each task line, or tag non-PRD tasks as `[NON-PRD]`.
|
|
11
|
+
- Do not invent PRD IDs in `tasks.md`. Only reference IDs that already exist in `docs/prd` or the upstream requirements doc.
|
|
12
|
+
- If this is a legacy feature without PRD IDs yet, backfill IDs in the source requirements doc first, then align `spec.md` `PRD Refs` and task tags together.
|
|
11
13
|
|
|
12
14
|
---
|
|
13
15
|
|
|
@@ -54,6 +56,8 @@
|
|
|
54
56
|
- [ ] (subtask)
|
|
55
57
|
```
|
|
56
58
|
|
|
59
|
+
> `PRD-FR-001` in the example means an ID that already exists in the PRD source. If it is not defined yet, do not add it to tasks first.
|
|
60
|
+
|
|
57
61
|
(Recommended) Requirement/scope change task:
|
|
58
62
|
|
|
59
63
|
Record mid-work changes as **new tasks**, and explicitly list which docs need updating via `Impact Docs`.
|
|
@@ -17,6 +17,7 @@ Core rule: once an idea becomes a Feature, the SSOT moves to `docs/features/`.
|
|
|
17
17
|
- PRD Refs (recommended): `PRD-FR-001, PRD-US-002` (use `NON-PRD` when not tied to PRD)
|
|
18
18
|
- Target component (optional): `api` / `app` / `worker` / `all`
|
|
19
19
|
- Status (recommended): `Active | Converted | Dropped`
|
|
20
|
+
- Only list IDs that already exist in the source PRD/requirements doc. If IDs do not exist yet, backfill the source first.
|
|
20
21
|
|
|
21
22
|
---
|
|
22
23
|
|
|
@@ -21,6 +21,8 @@ To let the CLI report “which PRD items are implemented”, assign **stable IDs
|
|
|
21
21
|
- The ID only needs to appear on the same line (heading/bullet).
|
|
22
22
|
- Reference it from a Feature `tasks.md` task line as a **bracket tag** like `[PRD-FR-001]`.
|
|
23
23
|
- For non-PRD tasks, tag them as `[NON-PRD]`.
|
|
24
|
+
- Important: do not invent PRD IDs in `tasks.md` or `spec.md`. Define them in this folder or the upstream requirements source first, then reference them.
|
|
25
|
+
- For legacy PRD/requirements docs without IDs yet, backfill IDs in the source first, then align the Feature `PRD Refs` and task tags.
|
|
24
26
|
|
|
25
27
|
Example:
|
|
26
28
|
|
|
@@ -45,12 +45,14 @@ npx lee-spec-kit context --json-compact
|
|
|
45
45
|
- **PRD (`docs/prd/`)**: 요구사항 SSOT
|
|
46
46
|
- 요구사항마다 ID를 부여합니다: `PRD-FR-001`, `PRD-US-002`, `PRD-NFR-003`
|
|
47
47
|
- ID는 안정적으로 유지합니다. (삭제 대신 `Deprecated` 표기 권장, 재번호 부여 금지)
|
|
48
|
+
- PRD ID는 PRD 원문에 먼저 정의합니다. Feature 문서에서 임의 생성하지 않습니다.
|
|
48
49
|
- **Ideas (`docs/ideas/`)**: Feature 전 단계 SSOT (가설/실험/후보)
|
|
49
50
|
- Idea 문서 상단에 `PRD Refs:`를 기록합니다. (예: `PRD-FR-001, PRD-US-002`)
|
|
50
51
|
- Feature로 승격되면 SSOT는 `docs/features/`로 이동하고, Idea는 archive로 정리합니다.
|
|
51
52
|
- **Features (`docs/features/`)**: 구현 범위/진행 SSOT
|
|
52
53
|
- `spec.md`: 범위 정의 + `PRD Refs`(기능이 커버하는 PRD ID 목록)
|
|
53
54
|
- `tasks.md`: 태스크 단위로 PRD ID를 태그(`[PRD-FR-001]`)로 매핑하거나, PRD 무관 태스크는 `[NON-PRD]`로 표시
|
|
55
|
+
- 레거시 문서에 PRD ID가 없다면, 먼저 원문 요구사항 문서에 ID를 backfill한 뒤 Feature 문서를 연결합니다.
|
|
54
56
|
- `decisions.md`: 변경/트레이드오프/요구사항 변경(왜 바뀌었는지) 기록 + Evidence 링크
|
|
55
57
|
|
|
56
58
|
## 변경 프로토콜 (중간에 요구사항/기능이 추가·변경될 때)
|
|
@@ -64,6 +64,7 @@ npx lee-spec-kit status --write
|
|
|
64
64
|
|
|
65
65
|
- PRD 문서(`docs/prd/*.md`)에 `PRD-FR-001` 같은 요구사항 ID를 부여하세요.
|
|
66
66
|
- `tasks.md`의 각 태스크 라인에 `[PRD-FR-001]` 태그로 연결하세요. PRD와 무관한 태스크는 `[NON-PRD]`를 사용하세요.
|
|
67
|
+
- 단, 태스크 문서에서 PRD ID를 임의 생성하지 않습니다. 먼저 PRD 원문에 정의하고, 레거시 문서는 원문 ID backfill 후 연결하세요.
|
|
67
68
|
- 커버리지 리포트: `npx lee-spec-kit requirements` (alias: `npx lee-spec-kit prd`)
|
|
68
69
|
|
|
69
70
|
---
|
|
@@ -56,4 +56,6 @@
|
|
|
56
56
|
|
|
57
57
|
- PRD: `../../prd/`
|
|
58
58
|
- PRD Refs: - (예: `PRD-FR-001`, `PRD-US-002`)
|
|
59
|
+
- 이미 원문 요구사항 문서에 정의된 ID만 적으세요. `spec.md`나 `tasks.md`에서 임의로 PRD ID를 만들지 않습니다.
|
|
60
|
+
- 레거시 요구사항 문서에 아직 PRD ID가 없다면, 먼저 원문에 ID를 backfill한 뒤 이 필드와 `tasks.md` 태스크 태그를 함께 갱신하세요.
|
|
59
61
|
- 요구사항/스코프 변경 시 PRD 문서 + 이 필드 + `tasks.md` 태스크 태그를 함께 갱신하세요.
|
|
@@ -8,6 +8,8 @@
|
|
|
8
8
|
- `[DOING] → [DONE]`: 완료 전 결과/검증 공유 + 사용자 승인(OK)
|
|
9
9
|
- **우선순위**: P0(긴급) > P1(높음) > P2(보통) > P3(낮음)
|
|
10
10
|
- **PRD 매핑(권장)**: 각 태스크 라인에 `[PRD-FR-001]` 같은 PRD 요구사항 ID 태그를 추가하거나, PRD와 무관한 태스크는 `[NON-PRD]`로 표시하세요.
|
|
11
|
+
- 단, `tasks.md`에서 PRD ID를 임의로 만들지 마세요. `docs/prd` 또는 상위 요구사항 문서에 먼저 정의된 ID만 참조해야 합니다.
|
|
12
|
+
- 레거시 문서에 아직 PRD ID가 없다면, 먼저 원문 요구사항 문서에 ID를 backfill한 뒤 `spec.md`의 `PRD Refs`와 태스크 태그를 함께 맞추세요.
|
|
11
13
|
|
|
12
14
|
---
|
|
13
15
|
|
|
@@ -54,6 +56,8 @@
|
|
|
54
56
|
- [ ] (서브 태스크)
|
|
55
57
|
```
|
|
56
58
|
|
|
59
|
+
> 위 예시의 `PRD-FR-001`은 이미 PRD 원문에 존재하는 ID를 뜻합니다. 아직 정의되지 않았다면 태스크에 먼저 넣지 마세요.
|
|
60
|
+
|
|
57
61
|
(권장) 요구사항/범위 변경 태스크:
|
|
58
62
|
|
|
59
63
|
중간 변경은 **새 태스크로 추가**하고, 어떤 문서를 함께 업데이트해야 하는지 `Impact Docs`로 명시합니다.
|
|
@@ -17,6 +17,7 @@ Feature로 발전하기 전의 아이디어 / To-do / 실험 기록을 모아두
|
|
|
17
17
|
- PRD Refs(권장): `PRD-FR-001, PRD-US-002` (PRD와 무관하면 `NON-PRD` 명시)
|
|
18
18
|
- 대상 컴포넌트(필요 시): `api` / `app` / `worker` / `all`
|
|
19
19
|
- 상태(권장): `Active | Converted | Dropped`
|
|
20
|
+
- `PRD Refs`에는 이미 원문 PRD/요구사항 문서에 정의된 ID만 적습니다. 아직 ID가 없다면 원문부터 backfill하세요.
|
|
20
21
|
|
|
21
22
|
---
|
|
22
23
|
|
|
@@ -21,6 +21,8 @@ PRD의 “어느 요구사항이 구현됐는지”를 CLI가 집계할 수 있
|
|
|
21
21
|
- 같은 줄(헤더/불릿) 안에 ID만 포함되어 있으면 됩니다.
|
|
22
22
|
- Feature의 `tasks.md` 태스크 라인에 `[PRD-FR-001]`처럼 **대괄호 태그**로 참조하세요.
|
|
23
23
|
- PRD와 무관한 태스크는 `[NON-PRD]` 태그로 표시하세요.
|
|
24
|
+
- 중요한 점: `tasks.md`나 `spec.md`에서 PRD ID를 임의로 만들지 않습니다. 항상 이 폴더나 상위 요구사항 원문에 먼저 정의한 뒤 참조하세요.
|
|
25
|
+
- 레거시 PRD/요구사항 문서에 아직 ID가 없다면, 먼저 원문 문서에 ID를 backfill한 뒤 Feature의 `PRD Refs`와 태스크 태그를 맞추세요.
|
|
24
26
|
|
|
25
27
|
예시:
|
|
26
28
|
|