Skip to content

Commit 72e66c4

Browse files
committed
update SKILL.md and spec-driven-development.md to implement a sequential ID system for spec folders and enhance the INDEX.md overview with formatting rules and status tracking
1 parent c857e89 commit 72e66c4

2 files changed

Lines changed: 40 additions & 11 deletions

File tree

claude-project-base/conventions/spec-driven-development.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,45 @@ Specs live in a `specs/` directory in the project root. Each spec gets its own s
1515

1616
```
1717
specs/
18-
├── 42-user-auth-flow/
18+
├── INDEX.md
19+
├── 001-user-auth-flow/
1920
│ ├── design.md
2021
│ ├── behaviors.md
2122
│ └── steps.md (optional)
22-
├── 87-csv-export-api/
23+
├── 002-csv-export-api/
2324
│ ├── design.md
2425
│ └── behaviors.md
2526
└── ...
2627
```
2728

2829
### Folder Naming
2930

30-
- **Based on a GitHub issue:** `<issue-number>-short-description` (e.g., `42-user-auth-flow`)
31-
- **Without an issue:** `short-description` (e.g., `csv-export-api`)
32-
- Keep the description to 3–4 words in kebab-case
31+
- Format: `<sequential-number>-short-description` (e.g., `001-user-auth-flow`, `002-csv-export-api`)
32+
- The sequential number is zero-padded to 3 digits and incremented from the last entry in `INDEX.md`.
33+
- Keep the description to 3–4 words in kebab-case.
34+
35+
### `INDEX.md` — Spec Overview
36+
37+
The file `specs/INDEX.md` is a central index of all specs. It provides Claude and developers with an at-a-glance overview of which specs exist, what they cover, and whether they have been implemented.
38+
39+
Format:
40+
41+
```markdown
42+
# Spec Index
43+
44+
| ID | Name | Description | GitHub Issue | Status |
45+
|-----|------|-------------|--------------|--------|
46+
| 001 | User auth flow | JWT-based login and registration with refresh tokens | #42 | done |
47+
| 002 | CSV export API | REST endpoint to export filtered datasets as CSV | #87 | open |
48+
| 003 | Rate limiting | Token-bucket rate limiting for all public API endpoints || in progress |
49+
```
50+
51+
Rules:
52+
- Every spec must have an entry in `INDEX.md`. A spec without an index entry is incomplete.
53+
- **Status** values: `open` (not started), `in progress` (being implemented), `done` (implemented and verified).
54+
- **GitHub Issue** column contains the issue reference (e.g., `#42`) or `` if no issue exists.
55+
- The index is updated whenever a spec is created or its status changes.
56+
- The sequential ID in the index determines the canonical order of specs.
3357

3458
## Files
3559

claude-project-base/skills/spec-create/SKILL.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ Present the drafted issues to the user for review and adjustment. **Do not creat
5151

5252
### 3. Create the spec folder
5353

54-
Create the spec folder under `specs/` following the naming convention from the spec-driven development doc.
54+
Determine the next sequential ID by reading `specs/INDEX.md`. If the file does not exist yet, create it with the table header (see spec-driven development doc) and start at `001`. Otherwise, increment from the highest existing ID.
55+
56+
Create the spec folder under `specs/` using the format `<ID>-short-description` (e.g., `001-user-auth-flow`).
5557

5658
### 4. Write `design.md` — Interactive planning
5759

@@ -96,8 +98,11 @@ Review the scenarios with the user. Ask explicitly: "Are there edge cases or err
9698

9799
### 6. Summary
98100

99-
After both files are written, provide a short summary:
100-
- Link to the created spec folder
101-
- Count of behavioral scenarios
102-
- Any open questions from the design
103-
- Suggest next steps: implement manually, use `/spec-implement` for a step-by-step plan, or use `/spec-review` after implementation to verify completeness
101+
After both files are written:
102+
103+
1. **Update `specs/INDEX.md`** — Add a new row with the spec's ID, name, GitHub issue reference (or ``), and status `open`.
104+
2. Provide a short summary:
105+
- Link to the created spec folder
106+
- Count of behavioral scenarios
107+
- Any open questions from the design
108+
- Suggest next steps: implement manually, use `/spec-implement` for a step-by-step plan, or use `/spec-review` after implementation to verify completeness

0 commit comments

Comments
 (0)