teamspec 3.2.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/LICENSE +21 -0
- package/README.md +252 -0
- package/bin/teamspec-init.js +10 -0
- package/extensions/teamspec-0.1.0.vsix +0 -0
- package/lib/cli.js +1174 -0
- package/lib/extension-installer.js +236 -0
- package/lib/linter.js +1184 -0
- package/lib/prompt-generator.js +409 -0
- package/package.json +51 -0
- package/teamspec-core/agents/AGENT_BA.md +486 -0
- package/teamspec-core/agents/AGENT_BOOTSTRAP.md +447 -0
- package/teamspec-core/agents/AGENT_DES.md +623 -0
- package/teamspec-core/agents/AGENT_DEV.md +611 -0
- package/teamspec-core/agents/AGENT_FA.md +736 -0
- package/teamspec-core/agents/AGENT_FEEDBACK.md +202 -0
- package/teamspec-core/agents/AGENT_FIX.md +380 -0
- package/teamspec-core/agents/AGENT_QA.md +756 -0
- package/teamspec-core/agents/AGENT_SA.md +581 -0
- package/teamspec-core/agents/AGENT_SM.md +771 -0
- package/teamspec-core/agents/README.md +383 -0
- package/teamspec-core/context/_schema.yml +222 -0
- package/teamspec-core/copilot-instructions.md +356 -0
- package/teamspec-core/definitions/definition-of-done.md +129 -0
- package/teamspec-core/definitions/definition-of-ready.md +104 -0
- package/teamspec-core/profiles/enterprise.yml +127 -0
- package/teamspec-core/profiles/platform-team.yml +104 -0
- package/teamspec-core/profiles/regulated.yml +97 -0
- package/teamspec-core/profiles/startup.yml +85 -0
- package/teamspec-core/teamspec.yml +69 -0
- package/teamspec-core/templates/README.md +211 -0
- package/teamspec-core/templates/active-sprint-template.md +98 -0
- package/teamspec-core/templates/adr-template.md +194 -0
- package/teamspec-core/templates/bug-report-template.md +188 -0
- package/teamspec-core/templates/business-analysis-template.md +164 -0
- package/teamspec-core/templates/decision-log-template.md +216 -0
- package/teamspec-core/templates/feature-template.md +269 -0
- package/teamspec-core/templates/functional-spec-template.md +161 -0
- package/teamspec-core/templates/refinement-notes-template.md +133 -0
- package/teamspec-core/templates/sprint-goal-template.md +129 -0
- package/teamspec-core/templates/sprint-template.md +175 -0
- package/teamspec-core/templates/sprints-index-template.md +67 -0
- package/teamspec-core/templates/story-template.md +244 -0
- package/teamspec-core/templates/storymap-template.md +204 -0
- package/teamspec-core/templates/testcases-template.md +147 -0
- package/teamspec-core/templates/uat-pack-template.md +161 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 TeamSpec Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
# TeamSpec CLI
|
|
2
|
+
|
|
3
|
+
> Bootstrap TeamSpec 2.0 Feature Canon Operating Model in any repository
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/teamspec)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
|
+
|
|
8
|
+
## What is TeamSpec?
|
|
9
|
+
|
|
10
|
+
TeamSpec is a **Feature Canon Operating Model** for software teams. It provides:
|
|
11
|
+
|
|
12
|
+
- **Feature Canon** — Single source of truth for system behavior
|
|
13
|
+
- **Delta-based Stories** — Stories describe changes, not full behavior
|
|
14
|
+
- **Role-based Workflows** — Clear ownership boundaries (BA, FA, SA, DEV, QA, SM)
|
|
15
|
+
- **AI Agent Integration** — Works with GitHub Copilot, Cursor, Claude, and more
|
|
16
|
+
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
### Global Install (Recommended)
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install -g teamspec
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### npx (No Install)
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npx teamspec
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Quick Start
|
|
32
|
+
|
|
33
|
+
### Interactive Setup
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
cd your-repo
|
|
37
|
+
teamspec
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
The CLI will ask:
|
|
41
|
+
1. Your team profile (startup, enterprise, regulated, etc.)
|
|
42
|
+
2. Organization and team name
|
|
43
|
+
3. Industry sector
|
|
44
|
+
4. Development cadence (scrum, kanban, scrumban)
|
|
45
|
+
5. Initial project ID
|
|
46
|
+
|
|
47
|
+
### Non-Interactive Setup
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
teamspec --profile startup --org "My Company" --team "Web Team" -y
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## What Gets Created
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
your-repo/
|
|
57
|
+
├── .teamspec/ # Core framework
|
|
58
|
+
│ ├── templates/ # Document templates
|
|
59
|
+
│ ├── definitions/ # DoR/DoD checklists
|
|
60
|
+
│ ├── profiles/ # Profile overlays
|
|
61
|
+
│ └── context/
|
|
62
|
+
│ └── team.yml # Your team configuration
|
|
63
|
+
├── .github/
|
|
64
|
+
│ └── copilot-instructions.md # GitHub Copilot guidance (optional)
|
|
65
|
+
├── projects/main-project/ # Project artifacts
|
|
66
|
+
│ ├── features/ # Feature Canon (source of truth)
|
|
67
|
+
│ │ ├── features-index.md # Feature registry
|
|
68
|
+
│ │ └── story-ledger.md # Completed story tracking
|
|
69
|
+
│ ├── stories/ # User stories
|
|
70
|
+
│ │ ├── backlog/ # New stories
|
|
71
|
+
│ │ ├── ready-to-refine/ # Ready for dev refinement
|
|
72
|
+
│ │ └── ready-for-development/# Ready for sprint
|
|
73
|
+
│ ├── adr/ # Architecture decisions
|
|
74
|
+
│ ├── decisions/ # Business decisions
|
|
75
|
+
│ ├── dev-plans/ # Development task breakdowns
|
|
76
|
+
│ ├── qa/ # Test cases
|
|
77
|
+
│ ├── sprints/ # Sprint management
|
|
78
|
+
│ └── epics/ # Epic specifications
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Commands
|
|
83
|
+
|
|
84
|
+
### Initialize TeamSpec
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
teamspec [init] [options]
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
**Options:**
|
|
91
|
+
|
|
92
|
+
| Option | Description |
|
|
93
|
+
|--------|-------------|
|
|
94
|
+
| `-t, --target <dir>` | Target directory (default: current) |
|
|
95
|
+
| `-p, --profile <profile>` | Team profile |
|
|
96
|
+
| `-o, --org <name>` | Organization name |
|
|
97
|
+
| `--team <name>` | Team name |
|
|
98
|
+
| `--project <id>` | Project ID |
|
|
99
|
+
| `--ide <ide>` | IDE integration (vscode, cursor, other, none) |
|
|
100
|
+
| `--copilot <yes\|no>` | Install GitHub Copilot instructions (default: yes) |
|
|
101
|
+
| `-y, --non-interactive` | Skip prompts, use defaults |
|
|
102
|
+
|
|
103
|
+
### Update TeamSpec
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
teamspec update [options]
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Updates templates, definitions, and profiles while preserving your team configuration.
|
|
110
|
+
|
|
111
|
+
**Options:**
|
|
112
|
+
|
|
113
|
+
| Option | Description |
|
|
114
|
+
|--------|-------------|
|
|
115
|
+
| `-f, --force` | Update without confirmation |
|
|
116
|
+
| `-y, --non-interactive` | Skip confirmation prompt |
|
|
117
|
+
|
|
118
|
+
## Profiles
|
|
119
|
+
|
|
120
|
+
| Profile | Description |
|
|
121
|
+
|---------|-------------|
|
|
122
|
+
| `none` | Vanilla TeamSpec |
|
|
123
|
+
| `startup` | Lean documentation, speed focus |
|
|
124
|
+
| `platform-team` | API-first, SLA focus |
|
|
125
|
+
| `enterprise` | Full governance, audit trails |
|
|
126
|
+
| `regulated` | Banking, healthcare, government compliance |
|
|
127
|
+
|
|
128
|
+
## TeamSpec Commands (for AI Agents)
|
|
129
|
+
|
|
130
|
+
Once configured, use these commands with your AI assistant:
|
|
131
|
+
|
|
132
|
+
### Business Analysis
|
|
133
|
+
|
|
134
|
+
```
|
|
135
|
+
ts:ba create # Create business analysis
|
|
136
|
+
ts:ba feature # Propose and create features
|
|
137
|
+
ts:ba epic # Propose epics with justification
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Functional Analysis
|
|
141
|
+
|
|
142
|
+
```
|
|
143
|
+
ts:fa story # Create user story
|
|
144
|
+
ts:fa slice # Slice requirements into stories
|
|
145
|
+
ts:fa sync # Update Feature Canon after story completion
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Development
|
|
149
|
+
|
|
150
|
+
```
|
|
151
|
+
ts:dev plan # Create development plan
|
|
152
|
+
ts:dev implement # Execute from existing plan
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Quality Assurance
|
|
156
|
+
|
|
157
|
+
```
|
|
158
|
+
ts:qa test # Design test cases
|
|
159
|
+
ts:qa bug # File bug report
|
|
160
|
+
ts:qa uat # Create UAT pack
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### Scrum Master
|
|
164
|
+
|
|
165
|
+
```
|
|
166
|
+
ts:sm sprint create # Create new sprint
|
|
167
|
+
ts:sm sprint status # View sprint status
|
|
168
|
+
ts:sm sprint close # Close sprint with metrics
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
## Key Concepts
|
|
172
|
+
|
|
173
|
+
### Feature Canon
|
|
174
|
+
|
|
175
|
+
The Feature Canon is the **single source of truth** for system behavior. It lives in `projects/<project-id>/features/` and contains:
|
|
176
|
+
|
|
177
|
+
- **Feature Files** — Define what the system does
|
|
178
|
+
- **Features Index** — Registry of all features
|
|
179
|
+
- **Story Ledger** — Tracks how features evolved through stories
|
|
180
|
+
|
|
181
|
+
### Delta-based Stories
|
|
182
|
+
|
|
183
|
+
Stories describe **changes** (deltas) to the Feature Canon, not full behavior:
|
|
184
|
+
|
|
185
|
+
```markdown
|
|
186
|
+
### Before (current behavior)
|
|
187
|
+
Reference: F-001, Section: User Registration
|
|
188
|
+
|
|
189
|
+
### After (new behavior)
|
|
190
|
+
Email confirmation is now optional for OAuth users.
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Workflow Folders
|
|
194
|
+
|
|
195
|
+
Stories move through workflow folders:
|
|
196
|
+
|
|
197
|
+
1. `stories/backlog/` — FA creates new stories here
|
|
198
|
+
2. `stories/ready-to-refine/` — FA moves stories ready for dev refinement
|
|
199
|
+
3. `stories/ready-for-development/` — DEV moves refined stories here
|
|
200
|
+
4. Sprint — SM assigns to active sprint
|
|
201
|
+
|
|
202
|
+
## Configuration
|
|
203
|
+
|
|
204
|
+
Edit `.teamspec/context/team.yml` to customize:
|
|
205
|
+
|
|
206
|
+
```yaml
|
|
207
|
+
org:
|
|
208
|
+
name: "Your Organization"
|
|
209
|
+
industry: technology
|
|
210
|
+
profile: startup
|
|
211
|
+
|
|
212
|
+
team:
|
|
213
|
+
name: "Your Team"
|
|
214
|
+
roles: [BA, FA, DEV, QA, SM]
|
|
215
|
+
cadence:
|
|
216
|
+
type: scrum
|
|
217
|
+
sprint_length_days: 14
|
|
218
|
+
|
|
219
|
+
tech:
|
|
220
|
+
stack:
|
|
221
|
+
- Python
|
|
222
|
+
- React
|
|
223
|
+
- PostgreSQL
|
|
224
|
+
|
|
225
|
+
governance:
|
|
226
|
+
sign_off_required: false
|
|
227
|
+
audit_trail: false
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
## Development
|
|
231
|
+
|
|
232
|
+
### Local Testing
|
|
233
|
+
|
|
234
|
+
```bash
|
|
235
|
+
cd cli
|
|
236
|
+
npm link
|
|
237
|
+
teamspec --help
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### Running Tests
|
|
241
|
+
|
|
242
|
+
```bash
|
|
243
|
+
npm test
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
## License
|
|
247
|
+
|
|
248
|
+
MIT
|
|
249
|
+
|
|
250
|
+
## Contributing
|
|
251
|
+
|
|
252
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
Binary file
|