groundwork-mcp 0.0.0-stage → 0.1.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 +202 -0
- package/NOTICE +5 -0
- package/README.md +124 -2
- package/SPEC.md +107 -0
- package/dist/chunk-3W4X6WV2.js +1524 -0
- package/dist/chunk-3W4X6WV2.js.map +1 -0
- package/dist/chunk-NRKF6WRA.js +16 -0
- package/dist/chunk-NRKF6WRA.js.map +1 -0
- package/dist/cli.js +160 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.d.ts +1113 -0
- package/dist/index.js +181 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp.js +12 -0
- package/dist/mcp.js.map +1 -0
- package/package.json +58 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
package/README.md
CHANGED
|
@@ -1,3 +1,125 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Groundwork
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**Your product evidence, in your repo, written by your own agent.**
|
|
4
|
+
|
|
5
|
+
Groundwork lets Claude Code (or any MCP agent) keep customer insights, hypotheses, experiments, findings and requirements as linked Markdown files in a `groundwork/` folder. Every requirement traces back to the findings, experiments and customer quotes behind it.
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
insight ──▶ hypothesis ──▶ experiment ──▶ finding ──▶ requirement
|
|
9
|
+
"I gave up "Guided import pilot, 10 "activation "Guided CSV
|
|
10
|
+
after 20 will lift accounts: 61% vs 38%" import"
|
|
11
|
+
minutes" activation" validated"
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
- **No account, no API keys, no server.** Your agent does the thinking. Groundwork checks the data, keeps links valid and computes experiment verdicts.
|
|
15
|
+
- **Plain files.** Read them, diff them, review them in pull requests, and keep them as long as you like.
|
|
16
|
+
- **Traceability.** Ask "why are we building this?" and get the full evidence chain, or check it in CI with `groundwork validate`.
|
|
17
|
+
|
|
18
|
+
## Quickstart (2 minutes)
|
|
19
|
+
|
|
20
|
+
In your project folder:
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
claude mcp add groundwork -- npx -y groundwork-mcp
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Or install the plugin, which adds the MCP server and a skill that teaches Claude when to use it:
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
/plugin marketplace add ganjilive/groundwork
|
|
30
|
+
/plugin install groundwork@groundwork
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Then talk to Claude as you normally would:
|
|
34
|
+
|
|
35
|
+
> Here are my notes from three customer interviews. Log the pains as insights.
|
|
36
|
+
>
|
|
37
|
+
> Draft a hypothesis from the onboarding insights, with a success metric.
|
|
38
|
+
>
|
|
39
|
+
> The pilot finished: activation went from 38% to 61%, support tickets stayed at 11 a week. Record it and write up the finding.
|
|
40
|
+
>
|
|
41
|
+
> Why are we building the guided import?
|
|
42
|
+
|
|
43
|
+
Groundwork writes files like `groundwork/insights/INS-0001-setup-takes-too-long.md`. Commit them like any other file.
|
|
44
|
+
|
|
45
|
+
## The CLI
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
npx -p groundwork-mcp groundwork init # create groundwork/config.yml
|
|
49
|
+
npx -p groundwork-mcp groundwork validate # check every item and link; exits 1 on errors
|
|
50
|
+
npx -p groundwork-mcp groundwork trace REQ-0002
|
|
51
|
+
npx -p groundwork-mcp groundwork list hypothesis
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
`trace` shows the chain behind an item (from [examples/acme](examples/acme)):
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
REQ-0002 Guided CSV import (solution, approved)
|
|
58
|
+
├─ finding FND-0001 Guided import lifts activation
|
|
59
|
+
│ ├─ experiment EXP-0001 Guided import pilot (completed, validated)
|
|
60
|
+
│ │ └─ hypothesis HYP-0001 Guided import (validated)
|
|
61
|
+
│ │ ├─ insight INS-0001 Setup takes too long
|
|
62
|
+
│ │ └─ insight INS-0002 Import errors are unclear
|
|
63
|
+
│ ├─ hypothesis HYP-0001 Guided import (validated) (shown above)
|
|
64
|
+
│ └─ insight INS-0001 Setup takes too long (shown above)
|
|
65
|
+
└─ requirement REQ-0001 Get set up without help (stakeholder, draft)
|
|
66
|
+
└─ finding FND-0001 Guided import lifts activation (shown above)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Run `validate` in CI to block pull requests with broken links:
|
|
70
|
+
|
|
71
|
+
```yaml
|
|
72
|
+
# .github/workflows/groundwork.yml
|
|
73
|
+
on: pull_request
|
|
74
|
+
jobs:
|
|
75
|
+
validate:
|
|
76
|
+
runs-on: ubuntu-latest
|
|
77
|
+
steps:
|
|
78
|
+
- uses: actions/checkout@v4
|
|
79
|
+
- run: npx -y -p groundwork-mcp groundwork validate
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Setup
|
|
83
|
+
|
|
84
|
+
`groundwork/config.yml` holds your product areas, products and people (for approvals). The first write creates it if it's missing. Fill it in so agents can tag items by area and send requirements for sign-off:
|
|
85
|
+
|
|
86
|
+
```yaml
|
|
87
|
+
name: Acme
|
|
88
|
+
productAreas:
|
|
89
|
+
- { id: onboarding, label: Onboarding }
|
|
90
|
+
products: [Acme app]
|
|
91
|
+
people:
|
|
92
|
+
- { id: sam, name: Sam, role: owner, email: sam@acme.example }
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Groundwork finds the project by looking for `groundwork/config.yml` in the current folder and the folders above it. Set `GROUNDWORK_DIR` to point somewhere else, and `GROUNDWORK_USER` to choose who you're acting as.
|
|
96
|
+
|
|
97
|
+
The full format, every field and the rules are in [SPEC.md](SPEC.md). See [examples/acme](examples/acme) for a sample project.
|
|
98
|
+
|
|
99
|
+
## Tools
|
|
100
|
+
|
|
101
|
+
| Read | Write | Lifecycle |
|
|
102
|
+
|---|---|---|
|
|
103
|
+
| `get_workspace` | `add_insights` | `start_experiment` |
|
|
104
|
+
| `search_items` | `add_hypotheses` | `record_experiment_results` |
|
|
105
|
+
| `get_item` | `add_experiment` | `submit_requirement_for_approval` |
|
|
106
|
+
| | `add_findings` | `approve_requirement` |
|
|
107
|
+
| | `add_requirements` | `send_back_requirement` |
|
|
108
|
+
| | `update_item`, `link_items` | `obsolete_requirement` |
|
|
109
|
+
| | `delete_item` | |
|
|
110
|
+
|
|
111
|
+
## Privacy
|
|
112
|
+
|
|
113
|
+
Insights hold what customers said, and these files usually end up in git. Groundwork tells agents to record a role ("Finance manager") and an optional reference ("P07"), never names or contact details. Check quotes before you commit them, and keep the repo private if they're sensitive.
|
|
114
|
+
|
|
115
|
+
## Groundwork for teams
|
|
116
|
+
|
|
117
|
+
The Groundwork web app adds dashboards, reports, a visual evidence graph, approvals with an audit trail and Linear sync for people who don't live in a terminal. You can import a `groundwork/` folder into it. The web app is a separate, paid product; this project is and stays open source.
|
|
118
|
+
|
|
119
|
+
## Contributing
|
|
120
|
+
|
|
121
|
+
Issues and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
122
|
+
|
|
123
|
+
## Licence
|
|
124
|
+
|
|
125
|
+
[Apache-2.0](LICENSE)
|
package/SPEC.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Groundwork file format, version 1
|
|
2
|
+
|
|
3
|
+
This is the contract between your files, the `groundwork` tools and anything else that reads them, including the Groundwork web app's importer. Everything lives in one folder, `groundwork/`, at the root of your project.
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
groundwork/
|
|
7
|
+
config.yml
|
|
8
|
+
insights/INS-0001-setup-takes-too-long.md
|
|
9
|
+
hypotheses/HYP-0001-guided-import.md
|
|
10
|
+
experiments/EXP-0001-guided-import-pilot.md
|
|
11
|
+
findings/FND-0001-guided-import-lifts-activation.md
|
|
12
|
+
requirements/REQ-0001-guided-csv-import.md
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Items
|
|
16
|
+
|
|
17
|
+
Each item is one Markdown file: YAML frontmatter between `---` lines, then an optional body.
|
|
18
|
+
|
|
19
|
+
```markdown
|
|
20
|
+
---
|
|
21
|
+
id: INS-0001
|
|
22
|
+
title: Setup takes too long
|
|
23
|
+
quote: I gave up on the import after twenty minutes.
|
|
24
|
+
source: interview
|
|
25
|
+
persona: Ops lead
|
|
26
|
+
participant: P07
|
|
27
|
+
tags: [onboarding]
|
|
28
|
+
sentiment: negative
|
|
29
|
+
productArea: onboarding
|
|
30
|
+
createdAt: 2026-11-18T10:00:00.000Z
|
|
31
|
+
createdBy: sam
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
Anything you write here is yours. Groundwork reads it as the item's `notes` and never rewrites it.
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
- **Ids** are a kind prefix and a number of at least four digits: `INS`, `HYP`, `EXP`, `FND`, `REQ`. They never change, and an id is never reused within its kind. New items get one more than the highest id of their kind.
|
|
38
|
+
- **File names** are `<id>-<slug>.md`. Only the id matters; the slug comes from the title at creation and stays when the title changes, so links to the file don't break. A file has to be in the folder for its kind.
|
|
39
|
+
- **Links** are lists of ids in fields such as `insightIds`. They point from an item to the evidence it builds on.
|
|
40
|
+
- **Unknown fields** are kept. Tools may add fields in later versions.
|
|
41
|
+
- **Times** are ISO 8601 strings. **People** are ids from `config.yml`.
|
|
42
|
+
|
|
43
|
+
### Fields by kind
|
|
44
|
+
|
|
45
|
+
Required fields are in bold.
|
|
46
|
+
|
|
47
|
+
**Insight** (`insights/`, `INS-`): evidence from a real person.
|
|
48
|
+
**`title`**, **`quote`** (what they said or did, verbatim), **`source`** (`interview` | `support` | `survey` | `analytics` | `observation`), **`persona`** (a role, never a name), `participant` (a reference such as P07), `tags`, `sentiment` (`negative` | `neutral` | `positive`), `productArea`, `createdAt`, `createdBy`.
|
|
49
|
+
|
|
50
|
+
**Hypothesis** (`hypotheses/`, `HYP-`): "We believe we will [outcome] if [forWhom] get [benefit] with [feature]."
|
|
51
|
+
**`title`**, **`outcome`**, **`forWhom`**, **`benefit`**, **`feature`**, **`status`** (`draft` | `testing` | `validated` | `invalidated`), `insightIds`, `successMetric` (`name`, `unit`, `baseline`, `target`, `direction`: `increase` | `decrease`, `timeframe`), `guardrail`, `knowWhen`, `alternatives`, `edge`, `riskiestAssumption`, `confidence` (0–100), `priority`, `productArea`, `owner`, `createdAt`, `updatedAt`.
|
|
52
|
+
|
|
53
|
+
**Experiment** (`experiments/`, `EXP-`): tests exactly one hypothesis.
|
|
54
|
+
**`title`**, **`hypothesisId`**, **`method`** (`pilot` | `ab-test` | `prototype-test` | `survey` | `fake-door` | `concierge`), **`description`**, **`primaryMetric`** (`name`, `unit`, `baseline`, `target`, `direction`, and `actual` once measured), **`status`** (`planned` | `running` | `completed`), `guardrails` (metrics that must not get worse), `sampleSize`, `durationWeeks`, `startDate`, `endDate`, `resultNotes`, `verdict` (`validated` | `invalidated` | `inconclusive`), `checkBackDate`, `owner`.
|
|
55
|
+
|
|
56
|
+
**Finding** (`findings/`, `FND-`): what was learned.
|
|
57
|
+
**`title`**, **`summary`**, `experimentIds`, `hypothesisIds`, `insightIds`, `confidence` (`low` | `medium` | `high`), `productArea`, `createdAt`.
|
|
58
|
+
|
|
59
|
+
**Requirement** (`requirements/`, `REQ-`): a stakeholder need, or what the product must do to meet one.
|
|
60
|
+
**`title`**, **`story`**, **`acceptanceCriteria`** (a list), **`status`** (`draft` | `awaiting-approval` | `approved` | `in-delivery` | `obsolete`), `kind` (`stakeholder` | `solution`; `solution` if left out), `stakeholder` (stakeholder requirements: who has the need), `product` and `stakeholderIds` (solution requirements), `priority` (`must` | `should` | `could`), `findingIds`, `insightIds`, `hypothesisIds`, `origin` (`tender` | `regulation` | `contract` | `customer-need`) and `originNote`, `approver`, `approvedBy`, `approvedAt`, `obsoletedBy`, `obsoletedAt`, `productArea`, `createdAt`, `updatedAt`.
|
|
61
|
+
|
|
62
|
+
A requirement needs `findingIds`, or an `origin` when it was decided outside the evidence loop.
|
|
63
|
+
|
|
64
|
+
### Links
|
|
65
|
+
|
|
66
|
+
| From | Field | To |
|
|
67
|
+
|---|---|---|
|
|
68
|
+
| hypothesis | `insightIds` | insights |
|
|
69
|
+
| experiment | `hypothesisId` | one hypothesis |
|
|
70
|
+
| finding | `experimentIds`, `hypothesisIds`, `insightIds` | experiments, hypotheses, insights |
|
|
71
|
+
| requirement | `findingIds`, `insightIds`, `hypothesisIds` | findings, insights, hypotheses |
|
|
72
|
+
| solution requirement | `stakeholderIds` | stakeholder requirements |
|
|
73
|
+
| requirement | `obsoletedBy` | the requirements that replaced it |
|
|
74
|
+
|
|
75
|
+
### Rules the tools apply
|
|
76
|
+
|
|
77
|
+
These rules live in the core library, so every Groundwork tool applies them the same way.
|
|
78
|
+
|
|
79
|
+
- Starting an experiment moves a `draft` hypothesis to `testing`.
|
|
80
|
+
- Recording results computes the verdict. It is **validated** when the primary metric reaches its target (`actual >= target` for `increase`, `<=` for `decrease`) and every guardrail holds. It is **invalidated** when either fails. The hypothesis moves to the same status.
|
|
81
|
+
- New hypotheses, findings and requirements without a `productArea` take the most common one among their linked evidence.
|
|
82
|
+
- Requirements go from `draft` to `awaiting-approval` (with an `approver`) to `approved`. The approver can send one back to `draft`. Only `approved` requirements can become `obsolete`.
|
|
83
|
+
- Deleting an item removes links to it. Deleting a hypothesis also deletes its experiments.
|
|
84
|
+
|
|
85
|
+
## config.yml
|
|
86
|
+
|
|
87
|
+
```yaml
|
|
88
|
+
schemaVersion: 1
|
|
89
|
+
name: Acme
|
|
90
|
+
productAreas:
|
|
91
|
+
- id: onboarding
|
|
92
|
+
label: Onboarding
|
|
93
|
+
products:
|
|
94
|
+
- Acme app
|
|
95
|
+
people:
|
|
96
|
+
- id: sam # used in createdBy, owner, approver
|
|
97
|
+
name: Sam
|
|
98
|
+
role: owner # owner | editor | viewer
|
|
99
|
+
email: sam@acme.example # optional: matched against `git config user.email`
|
|
100
|
+
migrated: https://… # set by the web app importer; local writes stop
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
The person acting is `$GROUNDWORK_USER` (a person id). Otherwise it's the person whose `email` matches git's, or the only person listed. If none of those apply, it's `me`.
|
|
104
|
+
|
|
105
|
+
## Versioning
|
|
106
|
+
|
|
107
|
+
`schemaVersion` changes only for changes that would break older readers. Tools refuse to write a version newer than they understand. Adding optional fields doesn't change the version.
|