storymaps 1.3.2 → 1.3.3
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 +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -38,6 +38,16 @@ npm install
|
|
|
38
38
|
npm link
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
+
## Use with AI Coding Agents
|
|
42
|
+
|
|
43
|
+
A story map makes a good specification for an AI coding agent: the YAML lists every step of the journey and the cards under each one, slice by slice. **Build with AI** on storymaps.io writes the command for you:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npx storymaps pull --force storymaps.io/abc123 && claude "The storymap file @storymap.yml describes a product plan in user story map format. Use it as a structured specification. Your task: build a functional prototype of the features listed in the 'MVP' slice."
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
From there you steer the agent a slice or a feature at a time ("now build search from the V1 slice"). When a feature has been through QA, set its cards to `status: done` in `storymap.yml` and `storymaps push`, so the map shows the progress to everyone else. Pull again before the next round to pick up changes made in the browser.
|
|
50
|
+
|
|
41
51
|
## Quick Start
|
|
42
52
|
|
|
43
53
|
```bash
|
|
@@ -317,16 +327,6 @@ Cards support: `name`, `body`, `color`, `status` (done / in-progress / planned /
|
|
|
317
327
|
|
|
318
328
|
Slices support: `name`, `stories`, `goal` (up to 200 characters), `targetDate` (`YYYY-MM-DD`), and `collapsed` with `closedReason` (complete / closed).
|
|
319
329
|
|
|
320
|
-
## Use with AI Coding Agents
|
|
321
|
-
|
|
322
|
-
A story map makes a good specification for an AI coding agent: the YAML lists every step of the journey and the cards under each one, slice by slice. **Build with AI** on storymaps.io writes the command for you:
|
|
323
|
-
|
|
324
|
-
```bash
|
|
325
|
-
npx storymaps pull --force storymaps.io/abc123 && claude "The storymap file @storymap.yml describes a product plan in user story map format. Use it as a structured specification. Your task: build a functional prototype of the features listed in the 'MVP' slice."
|
|
326
|
-
```
|
|
327
|
-
|
|
328
|
-
From there you steer the agent a slice or a feature at a time ("now build search from the V1 slice"). When a feature has been through QA, set its cards to `status: done` in `storymap.yml` and `storymaps push`, so the map shows the progress to everyone else. Pull again before the next round to pick up changes made in the browser.
|
|
329
|
-
|
|
330
330
|
## Self-Hosting
|
|
331
331
|
|
|
332
332
|
The CLI works with any storymaps.io instance:
|