@boopkit/cap-product-design 0.1.1 → 0.3.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 +49 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# @boopkit/cap-product-design
|
|
2
|
+
|
|
3
|
+
**Part of [Boop](https://www.npmjs.com/package/@boopkit/cli)** — a bootstrap platform for AI-first builders. `boop init` scaffolds a running Node/TypeScript web app from composable **capabilities**, each one bundling the code, dependencies, middleware wiring, and agent skills needed for a feature. You pick the capabilities; `boop add` handles the rest.
|
|
4
|
+
|
|
5
|
+
`cap-product-design` is a skills-only capability covering the "think before you build" stretch of the workflow. It teaches an agent how to pull clear requirements from a vague founder brief, how to write an engineering design doc that exposes trade-offs (not just outcomes), how to document a feature for a specific audience, and how to fold new knowledge into the project's living `reference/` wiki after shipping.
|
|
6
|
+
|
|
7
|
+
## What You Get
|
|
8
|
+
|
|
9
|
+
A bundle of agent-facing skill files for requirements, design, feature docs, and reference-doc integration. No runtime code, no dependencies, no server wiring — documentation-as-code for the agents working in your repo.
|
|
10
|
+
|
|
11
|
+
### Skills installed
|
|
12
|
+
|
|
13
|
+
Copied into `skills/` on install:
|
|
14
|
+
|
|
15
|
+
- `reqs.feature-requirements.skill.md` — how to turn a brief or vague directive into real requirements: ask 3-5 focused trade-off questions, push back on ambiguity without interrogating, and know when enough clarity is enough to proceed.
|
|
16
|
+
- `reqs.feature-documentation.skill.md` — how to write feature documentation aimed at a specific audience and activity, with the right tone and grounding for readers who haven't done this before.
|
|
17
|
+
- `design.engineering-design.skill.md` — the engineering design doc structure (Goals, Non-Goals, Approach, Alternatives, Tradeoffs, Open Questions) with a stance: make the *decision* visible, not just the solution.
|
|
18
|
+
- `docs.reference-integration.skill.md` — how to blend new knowledge into `reference/` after a feature lands, keeping it a living wiki of what the system actually is, not a pile of per-feature pages.
|
|
19
|
+
|
|
20
|
+
## Requirements
|
|
21
|
+
|
|
22
|
+
**Other capabilities:** none.
|
|
23
|
+
|
|
24
|
+
**npm dependencies added to your project:** none. `cap-product-design` is pure documentation for agents.
|
|
25
|
+
|
|
26
|
+
**Environment variables:** none.
|
|
27
|
+
|
|
28
|
+
**Project files referenced:** several skills point at `reference/tenets.ref.md` for overarching principles. That file is provided by the `web-app` profile's `reference/` directory. In other profiles, the skill will still work — the reference link just won't resolve.
|
|
29
|
+
|
|
30
|
+
## Usage
|
|
31
|
+
|
|
32
|
+
Skills are meant to be read by AI agents, not humans (though humans are welcome). Once installed they live in your project's `skills/` directory alongside skills from other capabilities.
|
|
33
|
+
|
|
34
|
+
How agents find them depends on the harness:
|
|
35
|
+
|
|
36
|
+
- Projects with a Claude Code `CLAUDE.md` typically instruct the agent to consult `skills/index.md` or the relevant `.skill.md` file before acting.
|
|
37
|
+
- Harnesses with a native skill-discovery system (e.g. slash-command style skills) surface them by filename.
|
|
38
|
+
|
|
39
|
+
A typical flow: a founder gives the agent a two-sentence feature brief. The agent reads `reqs.feature-requirements.skill.md` and asks a few trade-off questions to fill the gaps. Once the shape is clear it reads `design.engineering-design.skill.md` and writes a design doc with an explicit Alternatives section. After the feature ships, it reads `docs.reference-integration.skill.md` and blends the new behaviour into the existing concept pages in `reference/` — not a new feature-specific page.
|
|
40
|
+
|
|
41
|
+
## Added by
|
|
42
|
+
|
|
43
|
+
Included by default in the `web-app` profile.
|
|
44
|
+
|
|
45
|
+
Add to an existing project with:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
boop add product-design
|
|
49
|
+
```
|