@trieungoctam/speckit 0.3.5 → 0.4.0
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 +12 -0
- package/dist/cli.js +22 -1
- package/dist/commands/doctor.js +12 -9
- package/dist/commands/graph.js +4 -2
- package/dist/commands/init.js +4 -2
- package/dist/commands/plan.js +37 -0
- package/dist/commands/quick.js +38 -0
- package/dist/commands/ready.js +6 -4
- package/dist/commands/score.d.ts +7 -0
- package/dist/commands/score.js +29 -0
- package/dist/commands/setup.js +24 -21
- package/dist/commands/sync.js +4 -2
- package/dist/commands/team.d.ts +10 -0
- package/dist/commands/team.js +129 -0
- package/dist/commands/validate.js +4 -2
- package/dist/core/colors.d.ts +11 -0
- package/dist/core/colors.js +40 -0
- package/dist/core/scaffold.js +2 -0
- package/dist/core/spec-score.d.ts +16 -0
- package/dist/core/spec-score.js +112 -0
- package/dist/core/team-report.d.ts +19 -0
- package/dist/core/team-report.js +149 -0
- package/dist/core/team-scaffold.d.ts +2 -0
- package/dist/core/team-scaffold.js +92 -0
- package/dist/core/templates.d.ts +1 -1
- package/dist/core/templates.js +15 -0
- package/docs/adapters.md +12 -0
- package/docs/code-standards.md +2 -0
- package/docs/development-roadmap.md +7 -3
- package/docs/enterprise-rollout.md +8 -3
- package/docs/product-contract.md +21 -2
- package/docs/project-changelog.md +31 -0
- package/docs/release-checklist.md +4 -0
- package/docs/spec-quality-gates.md +27 -0
- package/docs/system-architecture.md +19 -1
- package/docs/team-workflow.md +40 -0
- package/docs/use-cases.md +11 -0
- package/docs/workflow-model.md +31 -0
- package/package.json +1 -1
package/docs/product-contract.md
CHANGED
|
@@ -5,11 +5,13 @@ Speckit owns the workflow contract for enterprise Agile + TDD development with a
|
|
|
5
5
|
## Speckit Owns
|
|
6
6
|
|
|
7
7
|
- The `.speckit/` source of truth: config, rules, workflows, templates, generated artifacts.
|
|
8
|
-
- The command surface: `init`, `doctor`, `validate`, `start`, `memory`, `permissions`, `session`, `shape`, `plan`, `context`, `quick`, `sync`, `triage`, `sprint`, `graph`, `next`, `ready`, `run`, `review`, `close`.
|
|
8
|
+
- The command surface: `init`, `doctor`, `validate`, `start`, `memory`, `permissions`, `session`, `team`, `score`, `shape`, `plan`, `context`, `quick`, `sync`, `triage`, `sprint`, `graph`, `next`, `ready`, `run`, `review`, `close`.
|
|
9
9
|
- The skill catalog and super-agent routing contract for phase-specific agent behavior.
|
|
10
10
|
- IDE-specific initialization that installs the shared Speckit runtime plus only the selected IDE adapter when `--ide <name>` is provided.
|
|
11
11
|
- The long-session contract: project memory, active session state, checkpoints, compaction summaries, and resume handoffs.
|
|
12
12
|
- The workflow validation contract: phase order, core skills, super-agent routing, run prompt terms, and installed adapter prompt parity.
|
|
13
|
+
- The enterprise team contract: Product Owner, Analyst, Architect, Developer, QA/Test, and Reviewer/Lead artifact ownership.
|
|
14
|
+
- The runtime score contract: project and story health across workflow, team, session/context, graph, TDD, and review categories.
|
|
13
15
|
- The TDD gate: code stories require red, green, and refactor evidence.
|
|
14
16
|
- The adapter compiler for Claude Code, Codex, Antigravity, OpenCode, and Cursor.
|
|
15
17
|
- The safety policy for destructive commands, secrets, production access, and review readiness.
|
|
@@ -26,7 +28,24 @@ Speckit owns the workflow contract for enterprise Agile + TDD development with a
|
|
|
26
28
|
## State Model
|
|
27
29
|
|
|
28
30
|
```text
|
|
29
|
-
intake -> session -> memory-ready -> shaped -> planned -> sprint-ready -> context-ready -> synced -> graph-triaged -> ready-for-dev -> tests-red -> checkpointed -> running -> tests-green -> refactor -> compacted -> review-ready -> closed
|
|
31
|
+
intake -> session -> memory-ready -> shaped -> planned -> sprint-ready -> context-ready -> synced -> graph-triaged -> team-status -> ready-for-dev -> tests-red -> checkpointed -> running -> tests-green -> refactor -> team-audit -> compacted -> review-ready -> closed
|
|
30
32
|
```
|
|
31
33
|
|
|
32
34
|
Implementation starts only after `speckit ready <story>` passes. Review starts only after test evidence exists and the active session has a current checkpoint.
|
|
35
|
+
|
|
36
|
+
## Team Artifact Model
|
|
37
|
+
|
|
38
|
+
| Role | Owned Artifact |
|
|
39
|
+
| --- | --- |
|
|
40
|
+
| Product Owner | `Business Goal`, priority, success signal |
|
|
41
|
+
| Analyst | `Acceptance Criteria`, `Edge Cases` |
|
|
42
|
+
| Architect | `Implementation Scope`, `Architecture Notes` |
|
|
43
|
+
| Developer | `Dev Agent Record`, `File List`, `Change Log` |
|
|
44
|
+
| QA/Test | linked TDD evidence red, green, refactor sections |
|
|
45
|
+
| Reviewer/Lead | `Review Evidence`, follow-ups, close readiness |
|
|
46
|
+
|
|
47
|
+
`speckit team status` reports current ownership gaps. `speckit team audit` enforces the review gate. `speckit team handoff` records role transfer.
|
|
48
|
+
|
|
49
|
+
## Runtime Score Model
|
|
50
|
+
|
|
51
|
+
`speckit score` is a health signal, not a replacement for tests. It shows whether the project or story has enough durable workflow evidence to be understandable, reviewable, and handoff-ready.
|
|
@@ -1,5 +1,36 @@
|
|
|
1
1
|
# Project Changelog
|
|
2
2
|
|
|
3
|
+
## 0.4.0 - 2026-05-11
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
|
|
7
|
+
- Added the Enterprise Team Workflow layer with generated team role, artifact ownership, working agreement, review gate, and handoff protocol files.
|
|
8
|
+
- Added `speckit team status <story>` to show role-by-role artifact readiness for Product Owner, Analyst, Architect, Developer, QA/Test, and Reviewer/Lead.
|
|
9
|
+
- Added `speckit team audit <story> [--json]` for review-gate blocking checks that can run in CI.
|
|
10
|
+
- Added `speckit team handoff <story> --from <role> --to <role>` to create durable role handoff files.
|
|
11
|
+
- Added `speckit score [story] [--json]` to score project or story workflow health for enterprise demos and CI health reporting.
|
|
12
|
+
|
|
13
|
+
### Changed
|
|
14
|
+
|
|
15
|
+
- Story templates and generated quick/plan stories now include business goal, priority, edge cases, implementation scope, architecture notes, Dev Agent Record, File List, and Change Log sections for team traceability.
|
|
16
|
+
- `.beads/` is ignored as runtime graph mirror state.
|
|
17
|
+
|
|
18
|
+
### Quality
|
|
19
|
+
|
|
20
|
+
- Added enterprise team workflow tests for generated files, status, audit, and handoff behavior.
|
|
21
|
+
|
|
22
|
+
## 0.3.6 - 2026-05-11
|
|
23
|
+
|
|
24
|
+
### Added
|
|
25
|
+
|
|
26
|
+
- Added ANSI color rendering for interactive CLI and TUI output, including setup prompts, init summaries, doctor checks, graph setup, readiness, validation, sync, and help headers.
|
|
27
|
+
- Added `SPECKIT_COLOR=1` / `FORCE_COLOR` support for demos and snapshots, with `NO_COLOR` / `SPECKIT_COLOR=0` opt-out support.
|
|
28
|
+
|
|
29
|
+
### Quality
|
|
30
|
+
|
|
31
|
+
- Added color helper regression tests.
|
|
32
|
+
- JSON output remains uncolored for automation.
|
|
33
|
+
|
|
3
34
|
## 0.3.5 - 2026-05-11
|
|
4
35
|
|
|
5
36
|
### Added
|
|
@@ -6,12 +6,16 @@ Before publishing Speckit:
|
|
|
6
6
|
- [x] `npm run lint` passes.
|
|
7
7
|
- [x] `npm test` passes.
|
|
8
8
|
- [x] `bin/speckit init --ide all` works in a temporary directory.
|
|
9
|
+
- [x] `speckit init --enterprise --ide all` creates `.speckit/team/*`.
|
|
10
|
+
- [x] `speckit team status|audit|handoff` has test coverage.
|
|
11
|
+
- [x] `speckit score [story] --json` has test coverage.
|
|
9
12
|
- [x] `npm pack --dry-run` includes only package-safe files.
|
|
10
13
|
- [x] `package.json` name is `@trieungoctam/speckit` and `publishConfig.access` is `public`.
|
|
11
14
|
- [x] README uses `npx @trieungoctam/speckit@latest`.
|
|
12
15
|
- [x] Adapter output paths match `docs/adapters.md`.
|
|
13
16
|
- [x] Cursor output uses `.cursor/rules/*.mdc`, not `.cursorrules`.
|
|
14
17
|
- [x] `speckit next` only invokes `bv --robot-*`.
|
|
18
|
+
- [x] `.beads/` runtime mirror files are ignored by git.
|
|
15
19
|
- [ ] License and attribution review is complete for Speckit, Speckit Method, and Beads Viewer inspiration.
|
|
16
20
|
- [x] README quickstart is accurate.
|
|
17
21
|
- [x] No secrets, local credentials, or generated private data are included.
|
|
@@ -29,6 +29,8 @@ Every phase must link to the next durable artifact.
|
|
|
29
29
|
| context | story | context pack | story -> context |
|
|
30
30
|
| sync | story | graph task | story -> task id |
|
|
31
31
|
| run | task/story | TDD evidence | task -> evidence |
|
|
32
|
+
| team status | story + evidence | role readiness | role -> artifact |
|
|
33
|
+
| team audit | story + evidence | gate report | blocker -> owner |
|
|
32
34
|
| review | diff + evidence | review checklist | evidence -> review |
|
|
33
35
|
| close | review | changelog / graph close | review -> close |
|
|
34
36
|
|
|
@@ -51,6 +53,30 @@ All supported IDEs must receive the same Speckit policy:
|
|
|
51
53
|
- Session/context instructions
|
|
52
54
|
- Graph command safety
|
|
53
55
|
|
|
56
|
+
## Team Gate
|
|
57
|
+
|
|
58
|
+
Enterprise stories must expose role-owned artifacts:
|
|
59
|
+
|
|
60
|
+
- Product Owner: business goal, priority, success signal.
|
|
61
|
+
- Analyst: testable acceptance criteria and edge cases.
|
|
62
|
+
- Architect: implementation scope, constraints, and risks.
|
|
63
|
+
- Developer: Dev Agent Record, File List, and Change Log.
|
|
64
|
+
- QA/Test: red, green, and refactor evidence.
|
|
65
|
+
- Reviewer/Lead: review outcome and follow-ups.
|
|
66
|
+
|
|
67
|
+
Run:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
speckit team status <story>
|
|
71
|
+
speckit team audit <story> --json
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Score Gate
|
|
75
|
+
|
|
76
|
+
`speckit score` gives a project-level health signal across workflow contract, team operating model, context/session, and graph sync. `speckit score <story>` gives a story-level signal across team readiness, developer trace, TDD evidence, and review gate.
|
|
77
|
+
|
|
78
|
+
Use score as a rollout metric first. Only turn it into a hard CI threshold after the team agrees on acceptable minimums.
|
|
79
|
+
|
|
54
80
|
## Release Gate
|
|
55
81
|
|
|
56
82
|
Before release:
|
|
@@ -67,4 +93,5 @@ For enterprise releases:
|
|
|
67
93
|
```bash
|
|
68
94
|
speckit init --enterprise --ide all
|
|
69
95
|
speckit doctor --deep --json
|
|
96
|
+
speckit score --json
|
|
70
97
|
```
|
|
@@ -14,6 +14,9 @@ bin/speckit
|
|
|
14
14
|
- `src/commands/*`: command implementations with filesystem-safe outputs.
|
|
15
15
|
- `src/core/managed-files.ts`: creates or updates only Speckit-managed files unless forced.
|
|
16
16
|
- `src/core/scaffold.ts`: defines core `.speckit/` rules, workflows, and templates.
|
|
17
|
+
- `src/core/team-scaffold.ts`: defines generated team operating model files for enterprise mode.
|
|
18
|
+
- `src/core/team-report.ts`: evaluates role-owned story artifacts for team status, audit, and handoff.
|
|
19
|
+
- `src/core/spec-score.ts`: calculates project and story workflow health scores.
|
|
17
20
|
- `src/core/test-detection.ts`: detects project test commands for TDD evidence.
|
|
18
21
|
- `src/adapters/*`: renders native IDE config and instruction packs.
|
|
19
22
|
- `src/adapters/tool-checks.ts`: reports external tool availability.
|
|
@@ -21,7 +24,22 @@ bin/speckit
|
|
|
21
24
|
## Data Flow
|
|
22
25
|
|
|
23
26
|
```text
|
|
24
|
-
user intent -> CLI command -> markdown/json artifact -> IDE adapter -> agent workflow
|
|
27
|
+
user intent -> CLI command -> markdown/json artifact -> team/status gates -> IDE adapter -> agent workflow
|
|
25
28
|
```
|
|
26
29
|
|
|
27
30
|
The CLI does not depend on external workflow runtimes. Beads and Beads Viewer are optional integrations discovered at runtime.
|
|
31
|
+
|
|
32
|
+
## Enterprise Team Layer
|
|
33
|
+
|
|
34
|
+
```text
|
|
35
|
+
story + evidence
|
|
36
|
+
-> team-report
|
|
37
|
+
-> team status / audit / handoff
|
|
38
|
+
-> score
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Team checks are artifact-based. They inspect story sections, linked TDD evidence, and generated team contracts instead of relying on chat history.
|
|
42
|
+
|
|
43
|
+
## Score Layer
|
|
44
|
+
|
|
45
|
+
`speckit score` aggregates health across workflow contract, team operating model, context/session state, and graph sync. `speckit score <story>` aggregates story health across team readiness, developer trace, TDD evidence, and review gate.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Enterprise Team Workflow
|
|
2
|
+
|
|
3
|
+
Speckit Enterprise Team Workflow makes agentic development visible across roles. A role can be a person, a pair, or an agent, but every role owns durable artifacts.
|
|
4
|
+
|
|
5
|
+
## Roles
|
|
6
|
+
|
|
7
|
+
| Role | Owns | Speckit Checks |
|
|
8
|
+
| --- | --- | --- |
|
|
9
|
+
| Product Owner | business goal, priority | `Business Goal`, `Priority` |
|
|
10
|
+
| Analyst | acceptance criteria, edge cases | `Acceptance Criteria`, `Edge Cases` |
|
|
11
|
+
| Architect | scope, constraints, risk | `Implementation Scope`, `Architecture Notes` |
|
|
12
|
+
| Developer | implementation trace | `Dev Agent Record`, `File List`, `Change Log` |
|
|
13
|
+
| QA/Test | TDD proof | linked evidence `Red`, `Green`, `Refactor` |
|
|
14
|
+
| Reviewer/Lead | approval | `Review Evidence` |
|
|
15
|
+
|
|
16
|
+
## Flow
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
speckit setup
|
|
20
|
+
speckit quick "Add customer export"
|
|
21
|
+
speckit context .speckit/stories/<story>.md
|
|
22
|
+
speckit sync
|
|
23
|
+
speckit team status .speckit/stories/<story>.md
|
|
24
|
+
speckit ready .speckit/stories/<story>.md
|
|
25
|
+
speckit run .speckit/stories/<story>.md
|
|
26
|
+
speckit team handoff .speckit/stories/<story>.md --from dev --to qa
|
|
27
|
+
speckit team audit .speckit/stories/<story>.md
|
|
28
|
+
speckit score .speckit/stories/<story>.md
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Status Vs Audit
|
|
32
|
+
|
|
33
|
+
- `speckit team status <story>` answers where the story is blocked across roles.
|
|
34
|
+
- `speckit team audit <story>` answers whether the story can pass the review gate.
|
|
35
|
+
- `speckit team handoff <story> --from <role> --to <role>` writes a durable handoff for long sessions or role transfer.
|
|
36
|
+
- `speckit score <story>` gives a compact health score for team readiness, developer trace, TDD evidence, and review gate.
|
|
37
|
+
|
|
38
|
+
## Enterprise Rule
|
|
39
|
+
|
|
40
|
+
Do not advance a story by chat memory alone. Update the story, evidence, session, or handoff artifact first, then run team status or audit.
|
package/docs/use-cases.md
CHANGED
|
@@ -162,6 +162,10 @@ Best practices:
|
|
|
162
162
|
Use after implementation and tests pass.
|
|
163
163
|
|
|
164
164
|
```bash
|
|
165
|
+
speckit team status .speckit/stories/<story>.md
|
|
166
|
+
speckit team audit .speckit/stories/<story>.md
|
|
167
|
+
speckit score .speckit/stories/<story>.md
|
|
168
|
+
speckit team handoff .speckit/stories/<story>.md --from dev --to reviewer
|
|
165
169
|
speckit review
|
|
166
170
|
speckit session compact
|
|
167
171
|
speckit close .speckit/stories/<story>.md
|
|
@@ -172,6 +176,9 @@ speckit validate
|
|
|
172
176
|
Best practices:
|
|
173
177
|
|
|
174
178
|
- Review acceptance coverage before style or preference issues.
|
|
179
|
+
- Use `team status` to locate the role and artifact blocking review.
|
|
180
|
+
- Use `score <story>` as a quick executive summary before review or demo.
|
|
181
|
+
- Use `team handoff` when responsibility moves between dev, QA, reviewer, or lead.
|
|
175
182
|
- Check TDD evidence, session freshness, docs impact, and graph sync.
|
|
176
183
|
- Close only after the story has current evidence and a clean handoff.
|
|
177
184
|
- Sync after closing so downstream graph and sprint views are current.
|
|
@@ -187,12 +194,16 @@ npm run build
|
|
|
187
194
|
npm test
|
|
188
195
|
npx @trieungoctam/speckit@latest doctor --deep --json
|
|
189
196
|
npx @trieungoctam/speckit@latest validate --json
|
|
197
|
+
npx @trieungoctam/speckit@latest score --json
|
|
198
|
+
npx @trieungoctam/speckit@latest team audit .speckit/stories/<story>.md --json
|
|
190
199
|
```
|
|
191
200
|
|
|
192
201
|
Best practices:
|
|
193
202
|
|
|
194
203
|
- Fail CI when `validate` returns `needs-attention`.
|
|
204
|
+
- Use `score --json` as a non-blocking health metric until the team agrees on a threshold.
|
|
195
205
|
- Require `doctor --deep` before release branches are merged.
|
|
206
|
+
- Require `team audit` for stories that are ready for review or close.
|
|
196
207
|
- Keep generated prompt files reviewed like source code.
|
|
197
208
|
- Add new workflow phases only through the central contract and tests.
|
|
198
209
|
- Do not allow IDE-specific prompts to drift from the shared Speckit contract.
|
package/docs/workflow-model.md
CHANGED
|
@@ -47,6 +47,26 @@ Outputs:
|
|
|
47
47
|
- `.speckit/sprint/status.yaml`
|
|
48
48
|
- `.speckit/sprint/plan.md`
|
|
49
49
|
|
|
50
|
+
## Enterprise Team Lane
|
|
51
|
+
|
|
52
|
+
Use when a story moves across product, analysis, architecture, development, QA, and review responsibilities.
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
speckit team status .speckit/stories/<story>.md
|
|
56
|
+
speckit team handoff .speckit/stories/<story>.md --from dev --to qa
|
|
57
|
+
speckit team audit .speckit/stories/<story>.md
|
|
58
|
+
speckit score .speckit/stories/<story>.md
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Outputs:
|
|
62
|
+
|
|
63
|
+
- `.speckit/team/roles.md`
|
|
64
|
+
- `.speckit/team/artifact-ownership.md`
|
|
65
|
+
- `.speckit/team/review-gates.md`
|
|
66
|
+
- `.speckit/team/handoffs/<handoff>.md`
|
|
67
|
+
|
|
68
|
+
The team lane does not simulate people. It maps team responsibilities to durable artifacts so any person or agent can see which role is blocking the story.
|
|
69
|
+
|
|
50
70
|
## TDD Evidence Gate
|
|
51
71
|
|
|
52
72
|
Each code story must record:
|
|
@@ -72,3 +92,14 @@ Long-running agent work must keep durable state outside chat history:
|
|
|
72
92
|
`speckit sync` prepares both Speckit sync metadata and a Beads Viewer-compatible `.beads/beads.jsonl` mirror. `speckit graph triage|plan|insights` refreshes that mirror before invoking `bv --robot-*` from the project root, then falls back to local JSON if Beads Viewer is unavailable or still fails.
|
|
73
93
|
|
|
74
94
|
Run `speckit graph setup` on a new machine to print Beads Viewer install commands, check `br`/`bd`/`bv`, and prepare `.beads/beads.jsonl`.
|
|
95
|
+
|
|
96
|
+
## Runtime Score
|
|
97
|
+
|
|
98
|
+
Use score as the compact executive summary of workflow health:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
speckit score
|
|
102
|
+
speckit score .speckit/stories/<story>.md
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Project score checks workflow contract, team operating model, context/session, and graph sync. Story score checks team readiness, developer trace, TDD evidence, and review gate.
|