@boopkit/cap-product-design 0.3.1 → 0.4.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 CHANGED
@@ -12,10 +12,10 @@ A bundle of agent-facing skill files for requirements, design, feature docs, and
12
12
 
13
13
  Copied into `skills/` on install:
14
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.
15
+ - `boop-product-design-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
+ - `boop-product-design-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
+ - `boop-product-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
+ - `boop-product-design-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
19
 
20
20
  ## Requirements
21
21
 
@@ -33,10 +33,10 @@ Skills are meant to be read by AI agents, not humans (though humans are welcome)
33
33
 
34
34
  How agents find them depends on the harness:
35
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.
36
+ - Projects with a Claude Code `CLAUDE.md` typically instruct the agent to list the `skills/` directory and read each folder's `SKILL.md` frontmatter before acting.
37
+ - Harnesses with a native skill-discovery system (e.g. slash-command style skills) surface them by folder name.
38
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.
39
+ A typical flow: a founder gives the agent a two-sentence feature brief. The agent reads `boop-product-design-feature-requirements/SKILL.md` and asks a few trade-off questions to fill the gaps. Once the shape is clear it reads `boop-product-design-engineering-design/SKILL.md` and writes a design doc with an explicit Alternatives section. After the feature ships, it reads `boop-product-design-reference-integration/SKILL.md` and blends the new behaviour into the existing concept pages in `reference/` — not a new feature-specific page.
40
40
 
41
41
  ## Added by
42
42
 
package/capability.json CHANGED
@@ -5,5 +5,16 @@
5
5
  "dependencies": [],
6
6
  "devDependencies": [],
7
7
  "files": [],
8
- "skills": ["design.engineering-design.skill.md", "reqs.feature-documentation.skill.md", "reqs.feature-requirements.skill.md"]
8
+ "skills": [
9
+ "boop-product-design-engineering-design",
10
+ "boop-product-design-feature-documentation",
11
+ "boop-product-design-feature-requirements",
12
+ "boop-product-design-reference-integration"
13
+ ],
14
+ "skill_migrations": {
15
+ "boop-product-design-engineering-design": "design.engineering-design.skill.md",
16
+ "boop-product-design-feature-documentation": "reqs.feature-documentation.skill.md",
17
+ "boop-product-design-feature-requirements": "reqs.feature-requirements.skill.md",
18
+ "boop-product-design-reference-integration": "docs.reference-integration.skill.md"
19
+ }
9
20
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@boopkit/cap-product-design",
3
- "version": "0.3.1",
3
+ "version": "0.4.0",
4
4
  "description": "Product design skills for AI agents",
5
5
  "files": [
6
6
  "skills/",
@@ -1,5 +1,10 @@
1
+ ---
2
+ name: boop-product-design-engineering-design
3
+ description: "When you need to design a feature or system and communicate the technical decisions."
4
+ metadata:
5
+ category: design
6
+ ---
1
7
  # Engineering Design
2
- When you need to design a feature or system and communicate the technical decisions.
3
8
 
4
9
  ## Goal
5
10
  **Make the decision visible, not just the solution.**
@@ -44,7 +49,7 @@ Well-designed systems separate concerns into layers with clear responsibilities
44
49
  - **Entry points are thin dispatch** — parse, call, format. No business rules, no direct data access.
45
50
  - **Logic owns the rules** — all domain validation, calculations, and orchestration live here. This layer is transport-agnostic and testable in isolation.
46
51
  - **Data access is encapsulated** — the logic layer calls data abstractions; it doesn't construct raw queries or import database clients directly.
47
- - **Each layer has its own design skill** — before writing code in a layer, check `skills/index.md` for the matching design skill (e.g., controller design, service design, data model design).
52
+ - **Each layer has its own design skill** — before writing code in a layer, check the `skills/` directory for the matching design skill (e.g., controller design, service design, data model design).
48
53
 
49
54
  ### Why this matters for agents
50
55
 
@@ -1,5 +1,10 @@
1
+ ---
2
+ name: boop-product-design-feature-documentation
3
+ description: "When you need to document a complex feature, function or system"
4
+ metadata:
5
+ category: reqs
6
+ ---
1
7
  # Feature Documentation
2
- When you need to document a complex feature, function or system
3
8
  - Identity the intended audience. For example, data engineers who may not have done this sort of exercise before.
4
9
  - Identify the audience's "group identity". For example, which company, team, or project they belong to.
5
10
  - Identify the activity to be explained. For example, designing or operating at scale.
@@ -1,3 +1,9 @@
1
+ ---
2
+ name: boop-product-design-feature-requirements
3
+ description: "When you need to define what a feature should accomplish before designing how to build it."
4
+ metadata:
5
+ category: reqs
6
+ ---
1
7
  # Feature Requirements
2
8
 
3
9
  Be sure to read the [reference/tenets.ref.md](../reference/tenets.ref.md) for overarching principles that apply to all features.
@@ -1,5 +1,10 @@
1
+ ---
2
+ name: boop-product-design-reference-integration
3
+ description: "When you need to integrate new knowledge into the project's `reference/` directory after completing a feature, fixing a bug that changes behavior, or adding a capability."
4
+ metadata:
5
+ category: docs
6
+ ---
1
7
  # Reference Integration
2
- When you need to integrate new knowledge into the project's `reference/` directory after completing a feature, fixing a bug that changes behavior, or adding a capability.
3
8
 
4
9
  ## Goal
5
10
  Keep `reference/` as a living wiki of **what the system actually is right now** — not a pile of per-feature pages. New knowledge is blended into existing concept pages; new pages are created only when a genuinely new concept has no home.