@atheneworkai/speci5 0.1.0 → 0.1.2
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/README.md
CHANGED
|
@@ -7,7 +7,7 @@ A spec-driven development framework for AI-assisted coding. Gives your AI coding
|
|
|
7
7
|
Add speci5 to any project:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
npx speci5 init
|
|
10
|
+
npx @atheneworkai/speci5 init
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
This copies the skill definitions and config into your repo:
|
|
@@ -22,7 +22,7 @@ CLAUDE.md # Framework instructions for your AI agent
|
|
|
22
22
|
To update to the latest version:
|
|
23
23
|
|
|
24
24
|
```bash
|
|
25
|
-
npx speci5 update
|
|
25
|
+
npx @atheneworkai/speci5 update
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
## Usage
|
package/package.json
CHANGED
|
@@ -6,7 +6,13 @@ argument-hint: "Path to the story folder, e.g. .spec/features/user-auth/login-wi
|
|
|
6
6
|
|
|
7
7
|
# Plan
|
|
8
8
|
|
|
9
|
-
Read a story spec and create a concrete implementation plan
|
|
9
|
+
Read a story spec and create a concrete implementation plan.
|
|
10
|
+
|
|
11
|
+
Start by understanding the story and the codebase, then produce specific, actionable tasks. Only ask questions if the spec has genuine ambiguities that would lead to a wrong plan.
|
|
12
|
+
|
|
13
|
+
<HARD-GATE>
|
|
14
|
+
Do NOT implement code, modify specs, create features, or brainstorm ideas. This skill ONLY produces plan files in `.spec/features/<feature>/<story>/plan.md`.
|
|
15
|
+
</HARD-GATE>
|
|
10
16
|
|
|
11
17
|
## Triggers
|
|
12
18
|
|
|
@@ -23,17 +29,29 @@ Activate this skill when the user wants to:
|
|
|
23
29
|
3. If a `plan.md` already exists, update it — preserve any checked-off tasks and add/revise remaining ones.
|
|
24
30
|
4. Do NOT modify `story.md` or `feature.md` — those are the **specify** skill's domain.
|
|
25
31
|
5. Do NOT implement the code — only produce the plan.
|
|
32
|
+
6. **YAGNI ruthlessly** — Every task must tie back to an acceptance criterion. If it doesn't serve the story, leave it out.
|
|
33
|
+
|
|
34
|
+
## Conversation Style
|
|
35
|
+
|
|
36
|
+
- **Bias toward action.** If the story and codebase give enough information, produce the plan directly.
|
|
37
|
+
- **Only ask when genuinely blocked** — ambiguous acceptance criteria, multiple conflicting interpretations, or a technical decision with no clear answer.
|
|
38
|
+
- **One question at a time** if you do need to ask.
|
|
39
|
+
- **Prefer multiple choice** when possible.
|
|
26
40
|
|
|
27
41
|
## Steps
|
|
28
42
|
|
|
29
43
|
1. **Read the story** — Load `.spec/features/<feature>/<story>/story.md`.
|
|
30
44
|
2. **Read the feature** — Load the parent `feature.md` for broader context.
|
|
31
|
-
3. **Analyze the codebase** — Understand:
|
|
45
|
+
3. **Analyze the codebase** — Go beyond the story. Understand:
|
|
32
46
|
- Project structure, tech stack, and conventions.
|
|
33
47
|
- What related code already exists.
|
|
34
48
|
- Where new code should be placed.
|
|
35
|
-
|
|
36
|
-
|
|
49
|
+
- Existing patterns to follow (routing conventions, test structure, naming, etc.).
|
|
50
|
+
4. **Check scope** — If the story is too large or covers multiple independent concerns, flag it. Help decompose into smaller stories before planning. Each plan should be completable in a focused session.
|
|
51
|
+
5. **Ask clarifying questions (only if needed)** — If acceptance criteria are genuinely ambiguous or a technical decision has no clear answer from the codebase, ask. Otherwise, proceed.
|
|
52
|
+
6. **Propose 2-3 implementation approaches** — Present different strategies with trade-offs (e.g., new module vs. extending existing, library vs. hand-rolled). Lead with your recommendation and explain why.
|
|
53
|
+
7. **Write the plan** — Once aligned with the user, write ordered, actionable tasks to `.spec/features/<feature>/<story>/plan.md`.
|
|
54
|
+
8. **Present for review** — Show the plan and confirm it looks right before considering the job done.
|
|
37
55
|
|
|
38
56
|
## Output Format
|
|
39
57
|
|
|
@@ -6,6 +6,10 @@ Write to `.spec/features/<feature>/<story>/plan.md`:
|
|
|
6
6
|
## Context
|
|
7
7
|
Brief summary of what this plan implements and any technical decisions.
|
|
8
8
|
|
|
9
|
+
## Approach
|
|
10
|
+
Which implementation approach was chosen and why.
|
|
11
|
+
Note any alternatives considered and why they were ruled out.
|
|
12
|
+
|
|
9
13
|
## Tasks
|
|
10
14
|
- [ ] Task 1 — description with specifics (file paths, function names, etc.)
|
|
11
15
|
- [ ] Task 2 — description
|
|
@@ -8,6 +8,12 @@ argument-hint: "Name the idea(s) to specify, or leave blank to process all ideas
|
|
|
8
8
|
|
|
9
9
|
Transform idea documents into structured feature and story specs.
|
|
10
10
|
|
|
11
|
+
Start by understanding the ideas and the existing codebase, then produce clear, testable specifications. Only ask questions if the idea has genuine ambiguities that would lead to a wrong spec.
|
|
12
|
+
|
|
13
|
+
<HARD-GATE>
|
|
14
|
+
Do NOT create plan files, implement code, or brainstorm ideas. This skill ONLY produces `feature.md` and `story.md` files in `.spec/features/`. The **plan** skill is the next step.
|
|
15
|
+
</HARD-GATE>
|
|
16
|
+
|
|
11
17
|
## Triggers
|
|
12
18
|
|
|
13
19
|
Activate this skill when the user wants to:
|
|
@@ -25,14 +31,26 @@ Activate this skill when the user wants to:
|
|
|
25
31
|
5. Link stories in `feature.md` using relative paths.
|
|
26
32
|
6. If features/stories already exist, update them — do not overwrite human edits.
|
|
27
33
|
7. Present the proposed feature/story breakdown to the user for confirmation before writing files.
|
|
34
|
+
8. **YAGNI ruthlessly** — If a story isn't clearly needed for the feature's goals, leave it out. Fewer well-defined stories beat many vague ones.
|
|
35
|
+
|
|
36
|
+
## Conversation Style
|
|
37
|
+
|
|
38
|
+
- **Bias toward action.** If the idea and codebase give enough information, produce the specs directly.
|
|
39
|
+
- **Only ask when genuinely blocked** — ambiguous intent, multiple conflicting interpretations, or missing information that can't be inferred.
|
|
40
|
+
- **One question at a time** if you do need to ask.
|
|
41
|
+
- **Prefer multiple choice** when possible.
|
|
28
42
|
|
|
29
43
|
## Steps
|
|
30
44
|
|
|
31
45
|
1. **Read ideas** — Read the specified idea file(s) from `.spec/ideas/`. If none specified, read all.
|
|
32
|
-
2. **
|
|
33
|
-
3. **
|
|
34
|
-
4. **
|
|
35
|
-
5. **
|
|
46
|
+
2. **Explore project context** — Go beyond the ideas. Check the codebase, docs, and existing specs to understand what's already built, what conventions exist, and what patterns to follow. Specs should be grounded in reality.
|
|
47
|
+
3. **Read existing specs** — Scan `.spec/features/` to avoid duplicating or conflicting with what's already specified.
|
|
48
|
+
4. **Check scope** — If an idea covers multiple independent capabilities or is too broad, flag it. Help decompose into separate features before specifying. Each feature should be a single cohesive capability.
|
|
49
|
+
5. **Ask clarifying questions (only if needed)** — If the idea has genuine ambiguities or missing information that can't be inferred from context, ask. Otherwise, proceed.
|
|
50
|
+
6. **Synthesize** — Break ideas into **features** (cohesive capabilities) and **stories** (independently deliverable slices of a feature).
|
|
51
|
+
7. **Propose** — Present the feature/story breakdown with a brief rationale. Get user confirmation before writing files.
|
|
52
|
+
8. **Write specs** — For each feature, create a folder with `feature.md`. For each story, create a subfolder with `story.md`.
|
|
53
|
+
9. **Present for review** — Show the written specs and confirm they look right before considering the job done.
|
|
36
54
|
|
|
37
55
|
## Folder Structure
|
|
38
56
|
|
|
@@ -12,6 +12,9 @@ What this feature is and why it matters.
|
|
|
12
12
|
- Goal 1
|
|
13
13
|
- Goal 2
|
|
14
14
|
|
|
15
|
+
## Non-Goals
|
|
16
|
+
- What this feature explicitly does NOT cover.
|
|
17
|
+
|
|
15
18
|
## Stories
|
|
16
19
|
- [<story-title>](<story-slug>/)
|
|
17
20
|
- [<story-title>](<story-slug>/)
|
|
@@ -31,4 +34,7 @@ As a <role>, I can <action> so that <benefit>.
|
|
|
31
34
|
- [ ] Criterion 1
|
|
32
35
|
- [ ] Criterion 2
|
|
33
36
|
- [ ] Criterion 3
|
|
37
|
+
|
|
38
|
+
## Open Questions
|
|
39
|
+
- Any unresolved questions that may affect implementation.
|
|
34
40
|
```
|