@trieungoctam/speckit 0.3.6 → 0.4.1
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 +28 -3
- package/dist/cli.js +19 -0
- package/dist/commands/plan.js +37 -0
- package/dist/commands/quick.js +38 -0
- package/dist/commands/score.d.ts +7 -0
- package/dist/commands/score.js +29 -0
- package/dist/commands/team.d.ts +10 -0
- package/dist/commands/team.js +129 -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/getting-started.md +131 -0
- package/docs/product-contract.md +21 -2
- package/docs/project-changelog.md +28 -0
- package/docs/release-checklist.md +5 -0
- package/docs/spec-quality-gates.md +27 -0
- package/docs/system-architecture.md +19 -1
- package/docs/team-workflow.md +62 -0
- package/docs/use-cases.md +40 -9
- package/docs/workflow-model.md +31 -0
- package/package.json +1 -1
|
@@ -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,62 @@
|
|
|
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
|
+
Start with enterprise setup and verification:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
speckit setup
|
|
22
|
+
speckit doctor --deep
|
|
23
|
+
speckit validate
|
|
24
|
+
speckit score
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Run one story:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
speckit memory refresh
|
|
31
|
+
speckit session start "Add customer export"
|
|
32
|
+
speckit quick "Add customer export"
|
|
33
|
+
speckit context .speckit/stories/<story>.md
|
|
34
|
+
speckit sync
|
|
35
|
+
speckit team status .speckit/stories/<story>.md
|
|
36
|
+
speckit ready .speckit/stories/<story>.md
|
|
37
|
+
speckit run .speckit/stories/<story>.md
|
|
38
|
+
speckit team handoff .speckit/stories/<story>.md --from dev --to qa
|
|
39
|
+
speckit team audit .speckit/stories/<story>.md
|
|
40
|
+
speckit score .speckit/stories/<story>.md
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Status Vs Audit
|
|
44
|
+
|
|
45
|
+
- `speckit team status <story>` answers where the story is blocked across roles.
|
|
46
|
+
- `speckit team audit <story>` answers whether the story can pass the review gate.
|
|
47
|
+
- `speckit team handoff <story> --from <role> --to <role>` writes a durable handoff for long sessions or role transfer.
|
|
48
|
+
- `speckit score <story>` gives a compact health score for team readiness, developer trace, TDD evidence, and review gate.
|
|
49
|
+
|
|
50
|
+
## Role Handoff Examples
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
speckit team handoff .speckit/stories/<story>.md --from product-owner --to analyst
|
|
54
|
+
speckit team handoff .speckit/stories/<story>.md --from analyst --to architect
|
|
55
|
+
speckit team handoff .speckit/stories/<story>.md --from architect --to dev
|
|
56
|
+
speckit team handoff .speckit/stories/<story>.md --from dev --to qa
|
|
57
|
+
speckit team handoff .speckit/stories/<story>.md --from qa --to reviewer
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Enterprise Rule
|
|
61
|
+
|
|
62
|
+
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
|
@@ -28,10 +28,29 @@ Best practices:
|
|
|
28
28
|
|
|
29
29
|
- Prefer one IDE adapter per project at first. Add more adapters after the team agrees on the workflow.
|
|
30
30
|
- Run `speckit validate` after init so broken prompts or missing skills are caught immediately.
|
|
31
|
+
- Run `speckit score` after init. A low score is normal until session, context, and graph sync artifacts exist.
|
|
31
32
|
- Commit generated Speckit files so every teammate gets the same flow.
|
|
32
33
|
- Keep `.speckit/` local to the repository. Avoid relying on global agent state for enterprise work.
|
|
33
34
|
|
|
34
|
-
## 2.
|
|
35
|
+
## 2. Adapter Reset And Reinstall
|
|
36
|
+
|
|
37
|
+
Use when a repository already has old IDE adapter files and you want Speckit to regenerate them.
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
rm -rf .claude CLAUDE.md .codex AGENTS.md .cursor .opencode opencode.json
|
|
41
|
+
npx @trieungoctam/speckit@latest setup
|
|
42
|
+
speckit doctor --deep
|
|
43
|
+
speckit validate
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Best practices:
|
|
47
|
+
|
|
48
|
+
- Reset only repo-local adapter files unless you intentionally want to affect global IDE behavior.
|
|
49
|
+
- Use `--ide all` for mixed teams; otherwise select the one IDE adapter the repo actually uses.
|
|
50
|
+
- Review generated adapter files before committing them.
|
|
51
|
+
- Keep `.speckit/` files. The reset command is for IDE adapters, not the Speckit workflow source of truth.
|
|
52
|
+
|
|
53
|
+
## 3. Existing Project Migration
|
|
35
54
|
|
|
36
55
|
Use when a project already has code, tests, and team conventions.
|
|
37
56
|
|
|
@@ -49,7 +68,7 @@ Best practices:
|
|
|
49
68
|
- If an adapter prompt conflicts with local policy, update the adapter generator, not only the generated file.
|
|
50
69
|
- Run project tests after migration even if Speckit only changed documentation and prompt files.
|
|
51
70
|
|
|
52
|
-
##
|
|
71
|
+
## 4. One Small Change
|
|
53
72
|
|
|
54
73
|
Use when the request is bounded and can fit into one story.
|
|
55
74
|
|
|
@@ -70,7 +89,7 @@ Best practices:
|
|
|
70
89
|
- Keep acceptance criteria concrete enough to test.
|
|
71
90
|
- Checkpoint after the red test, green test, refactor, and review boundary.
|
|
72
91
|
|
|
73
|
-
##
|
|
92
|
+
## 5. Full Feature Planning
|
|
74
93
|
|
|
75
94
|
Use when the work includes multiple stories, architecture decisions, or team rollout.
|
|
76
95
|
|
|
@@ -91,7 +110,7 @@ Best practices:
|
|
|
91
110
|
- Sync stories before graph commands so prioritization uses current metadata.
|
|
92
111
|
- Use `sprint next` or `graph triage` to select work instead of choosing only by recency.
|
|
93
112
|
|
|
94
|
-
##
|
|
113
|
+
## 6. Long Agent Session
|
|
95
114
|
|
|
96
115
|
Use when work will span many tool calls, handoffs, or context compaction.
|
|
97
116
|
|
|
@@ -113,7 +132,7 @@ Best practices:
|
|
|
113
132
|
- Use `DONE`, `DONE_WITH_CONCERNS`, `BLOCKED`, or `NEEDS_CONTEXT` in handoffs.
|
|
114
133
|
- Never pass a full conversation as handoff context. Pass files, acceptance criteria, constraints, and current status.
|
|
115
134
|
|
|
116
|
-
##
|
|
135
|
+
## 7. TDD Implementation
|
|
117
136
|
|
|
118
137
|
Use for all code stories.
|
|
119
138
|
|
|
@@ -135,7 +154,7 @@ Best practices:
|
|
|
135
154
|
- Refactor only while tests stay green.
|
|
136
155
|
- Put command output summaries in the evidence file. Avoid pasting large logs unless they are necessary.
|
|
137
156
|
|
|
138
|
-
##
|
|
157
|
+
## 8. Graph And Sprint Automation
|
|
139
158
|
|
|
140
159
|
Use when multiple stories exist and the next task is not obvious.
|
|
141
160
|
|
|
@@ -157,11 +176,15 @@ Best practices:
|
|
|
157
176
|
- Treat graph output as prioritization input, not automatic permission to implement.
|
|
158
177
|
- Re-run `sprint plan` when story status or dependencies change.
|
|
159
178
|
|
|
160
|
-
##
|
|
179
|
+
## 9. Review And Closure
|
|
161
180
|
|
|
162
181
|
Use after implementation and tests pass.
|
|
163
182
|
|
|
164
183
|
```bash
|
|
184
|
+
speckit team status .speckit/stories/<story>.md
|
|
185
|
+
speckit team audit .speckit/stories/<story>.md
|
|
186
|
+
speckit score .speckit/stories/<story>.md
|
|
187
|
+
speckit team handoff .speckit/stories/<story>.md --from dev --to reviewer
|
|
165
188
|
speckit review
|
|
166
189
|
speckit session compact
|
|
167
190
|
speckit close .speckit/stories/<story>.md
|
|
@@ -172,11 +195,14 @@ speckit validate
|
|
|
172
195
|
Best practices:
|
|
173
196
|
|
|
174
197
|
- Review acceptance coverage before style or preference issues.
|
|
198
|
+
- Use `team status` to locate the role and artifact blocking review.
|
|
199
|
+
- Use `score <story>` as a quick executive summary before review or demo.
|
|
200
|
+
- Use `team handoff` when responsibility moves between dev, QA, reviewer, or lead.
|
|
175
201
|
- Check TDD evidence, session freshness, docs impact, and graph sync.
|
|
176
202
|
- Close only after the story has current evidence and a clean handoff.
|
|
177
203
|
- Sync after closing so downstream graph and sprint views are current.
|
|
178
204
|
|
|
179
|
-
##
|
|
205
|
+
## 10. CI And Enterprise Rollout
|
|
180
206
|
|
|
181
207
|
Use when Speckit becomes a shared team standard.
|
|
182
208
|
|
|
@@ -187,17 +213,21 @@ npm run build
|
|
|
187
213
|
npm test
|
|
188
214
|
npx @trieungoctam/speckit@latest doctor --deep --json
|
|
189
215
|
npx @trieungoctam/speckit@latest validate --json
|
|
216
|
+
npx @trieungoctam/speckit@latest score --json
|
|
217
|
+
npx @trieungoctam/speckit@latest team audit .speckit/stories/<story>.md --json
|
|
190
218
|
```
|
|
191
219
|
|
|
192
220
|
Best practices:
|
|
193
221
|
|
|
194
222
|
- Fail CI when `validate` returns `needs-attention`.
|
|
223
|
+
- Use `score --json` as a non-blocking health metric until the team agrees on a threshold.
|
|
195
224
|
- Require `doctor --deep` before release branches are merged.
|
|
225
|
+
- Require `team audit` for stories that are ready for review or close.
|
|
196
226
|
- Keep generated prompt files reviewed like source code.
|
|
197
227
|
- Add new workflow phases only through the central contract and tests.
|
|
198
228
|
- Do not allow IDE-specific prompts to drift from the shared Speckit contract.
|
|
199
229
|
|
|
200
|
-
##
|
|
230
|
+
## 11. Troubleshooting
|
|
201
231
|
|
|
202
232
|
Use these checks when the workflow feels inconsistent.
|
|
203
233
|
|
|
@@ -205,6 +235,7 @@ Use these checks when the workflow feels inconsistent.
|
|
|
205
235
|
speckit doctor --deep --json
|
|
206
236
|
speckit validate --json
|
|
207
237
|
speckit session status --json
|
|
238
|
+
speckit score --json
|
|
208
239
|
speckit sync
|
|
209
240
|
speckit graph triage --json
|
|
210
241
|
```
|
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.
|