Skip to content

Commit 52ce8b7

Browse files
author
Brian Casel
committed
updates to export package documentation and consolidated the foundation section prompt.
1 parent 7fde6af commit 52ce8b7

File tree

3 files changed

+51
-66
lines changed

3 files changed

+51
-66
lines changed

.claude/commands/design-os/export-product.md

Lines changed: 46 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,8 @@ product-plan/
6767
│ ├── one-shot-instructions.md # All milestones combined
6868
│ └── incremental/ # For milestone-by-milestone implementation
6969
│ ├── 01-foundation.md
70-
│ ├── 02-shell.md
71-
│ ├── 03-[first-section].md
72-
│ ├── 04-[second-section].md
70+
│ ├── 02-[first-section].md
71+
│ ├── 03-[second-section].md
7372
│ └── ...
7473
7574
├── design-system/ # Design tokens
@@ -143,10 +142,9 @@ Create `product-plan/product-overview.md`:
143142

144143
Build this product in milestones:
145144

146-
1. **Foundation** — Set up design tokens and data model types
147-
2. **Shell** — Implement the application shell and navigation
148-
3. **[Section 1]**[Brief description]
149-
4. **[Section 2]**[Brief description]
145+
1. **Foundation** — Set up design tokens, data model types, and application shell
146+
2. **[Section 1]**[Brief description]
147+
3. **[Section 2]**[Brief description]
150148
...
151149

152150
Each milestone has a dedicated instruction document in `product-plan/instructions/`.
@@ -201,7 +199,7 @@ Place in `product-plan/instructions/incremental/01-foundation.md`:
201199

202200
## Goal
203201

204-
Set up the foundational elements: design tokens, data model types, and routing structure.
202+
Set up the foundational elements: design tokens, data model types, routing structure, and application shell.
205203

206204
## What to Implement
207205

@@ -234,51 +232,23 @@ Create placeholder routes for each section:
234232

235233
[List routes based on roadmap sections]
236234

237-
## Files to Reference
238-
239-
- `product-plan/design-system/` — Design tokens
240-
- `product-plan/data-model/` — Type definitions
241-
242-
## Done When
243-
244-
- [ ] Design tokens are configured
245-
- [ ] Data model types are defined
246-
- [ ] Routes exist for all sections (can be placeholder pages)
247-
```
248-
249-
### 02-shell.md
250-
251-
Place in `product-plan/instructions/incremental/02-shell.md`:
252-
253-
```markdown
254-
# Milestone 2: Application Shell
255-
256-
> **Provide alongside:** `product-overview.md`
257-
> **Prerequisites:** Milestone 1 complete
258-
259-
## Goal
260-
261-
Implement the application shell — the persistent navigation and layout that wraps all sections.
262-
263-
## What to Implement
235+
### 4. Application Shell
264236

265237
[If shell exists:]
266238

267-
### Shell Components
268-
269239
Copy the shell components from `product-plan/shell/components/` to your project:
270240

271241
- `AppShell.tsx` — Main layout wrapper
272242
- `MainNav.tsx` — Navigation component
273243
- `UserMenu.tsx` — User menu with avatar
274244

275-
### Wire Up Navigation
245+
**Wire Up Navigation:**
276246

277247
Connect navigation to your routing:
278248

279249
[List nav items from shell spec]
280250

281-
### User Menu
251+
**User Menu:**
282252

283253
The user menu expects:
284254
- User name
@@ -294,12 +264,17 @@ Design and implement your own application shell with:
294264

295265
## Files to Reference
296266

297-
- `product-plan/shell/README.md` — Design intent
298-
- `product-plan/shell/components/` — React components
299-
- `product-plan/shell/screenshot.png` — Visual reference
267+
- `product-plan/design-system/` — Design tokens
268+
- `product-plan/data-model/` — Type definitions
269+
- `product-plan/shell/README.md` — Shell design intent
270+
- `product-plan/shell/components/` — Shell React components
271+
- `product-plan/shell/screenshot.png` — Shell visual reference
300272

301273
## Done When
302274

275+
- [ ] Design tokens are configured
276+
- [ ] Data model types are defined
277+
- [ ] Routes exist for all sections (can be placeholder pages)
303278
- [ ] Shell renders with navigation
304279
- [ ] Navigation links to correct routes
305280
- [ ] User menu shows user info
@@ -308,13 +283,13 @@ Design and implement your own application shell with:
308283

309284
### [NN]-[section-id].md (for each section)
310285

311-
Place in `product-plan/instructions/incremental/[NN]-[section-id].md`:
286+
Place in `product-plan/instructions/incremental/[NN]-[section-id].md` (starting at 02 for the first section):
312287

313288
```markdown
314289
# Milestone [N]: [Section Title]
315290

316291
> **Provide alongside:** `product-overview.md`
317-
> **Prerequisites:** Milestones 1-[N-1] complete
292+
> **Prerequisites:** Milestone 1 (Foundation) complete, plus any prior section milestones
318293
319294
## Goal
320295

@@ -490,21 +465,21 @@ The test instructions include:
490465

491466
# Milestone 1: Foundation
492467

493-
[Include 01-foundation.md content WITHOUT the preamble — it's already at the top]
468+
[Include 01-foundation.md content WITHOUT the preamble — it's already at the top. This includes design tokens, data model, routing, AND application shell.]
494469

495470
---
496471

497-
# Milestone 2: Application Shell
472+
# Milestone 2: [First Section Name]
498473

499-
[Include 02-shell.md content WITHOUT the preamble]
474+
[Include first section handoff content WITHOUT the preamble]
500475

501476
---
502477

503-
# Milestone 3: [Section Name]
478+
# Milestone 3: [Second Section Name]
504479

505-
[Include section handoff content WITHOUT the preamble]
480+
[Include second section handoff content WITHOUT the preamble]
506481

507-
[Repeat for all sections]
482+
[Repeat for all sections, incrementing milestone numbers]
508483
```
509484

510485
## Step 7: Copy and Transform Components
@@ -903,7 +878,11 @@ Please ask me clarifying questions about:
903878
- What database do you prefer?
904879
- Any specific hosting/deployment requirements?
905880

906-
4. **Any Other Clarifications**
881+
4. **Backend Business Logic**
882+
- Any server-side logic, validations or processes needed beyond what's shown in the UI?
883+
- Background processes, notifications, or other processes to trigger?
884+
885+
5. **Any Other Clarifications**
907886
- Questions about specific features or user flows
908887
- Edge cases that need clarification
909888
- Integration requirements
@@ -925,7 +904,7 @@ Create `product-plan/prompts/section-prompt.md`:
925904

926905
- **SECTION_NAME** = [Human-readable name, e.g., "Invoices" or "Project Dashboard"]
927906
- **SECTION_ID** = [Folder name in sections/, e.g., "invoices" or "project-dashboard"]
928-
- **NN** = [Milestone number, e.g., "03" or "04"]
907+
- **NN** = [Milestone number, e.g., "02" or "03" — sections start at 02 since 01 is Foundation]
929908

930909
---
931910

@@ -961,7 +940,11 @@ Please ask me clarifying questions about:
961940
- How should this section connect to existing features?
962941
- Any API endpoints already built that this should use?
963942

964-
4. **Any Other Clarifications**
943+
4. **Backend Business Logic**
944+
- Any server-side logic, validations or processes needed beyond what's shown in the UI?
945+
- Background processes, notifications, or other processes to trigger?
946+
947+
5. **Any Other Clarifications**
965948
- Questions about specific user flows in this section
966949
- Edge cases that need clarification
967950

@@ -996,7 +979,7 @@ This folder contains everything needed to implement [Product Name].
996979
**Instructions:**
997980
- `product-overview.md` — Product summary (provide with every implementation)
998981
- `instructions/one-shot-instructions.md` — All milestones combined for full implementation
999-
- `instructions/incremental/` — Milestone-by-milestone instructions (foundation, shell, sections)
982+
- `instructions/incremental/` — Milestone-by-milestone instructions (foundation, then sections)
1000983

1001984
**Design Assets:**
1002985
- `design-system/` — Colors, fonts, design tokens
@@ -1011,14 +994,13 @@ This folder contains everything needed to implement [Product Name].
1011994
Build your app milestone by milestone for better control:
1012995

1013996
1. Copy the `product-plan/` folder to your codebase
1014-
2. Start with Foundation (`instructions/incremental/01-foundation.md`)
1015-
3. Then Shell (`instructions/incremental/02-shell.md`)
1016-
4. For each section:
997+
2. Start with Foundation (`instructions/incremental/01-foundation.md`) — includes design tokens, data model, routing, and application shell
998+
3. For each section:
1017999
- Open `prompts/section-prompt.md`
10181000
- Fill in the section variables at the top (SECTION_NAME, SECTION_ID, NN)
10191001
- Copy/paste into your coding agent
10201002
- Answer questions and implement
1021-
5. Review and test after each milestone
1003+
4. Review and test after each milestone
10221004

10231005
### Option B: One-Shot
10241006

@@ -1044,12 +1026,11 @@ The test instructions are **framework-agnostic** — they describe WHAT to test,
10441026

10451027
## Tips
10461028

1047-
- Always include `product-overview.md` context — it helps your agent understand the full product
1048-
- Use the pre-written prompts — they include important clarifying questions about auth and data modeling
1049-
- Let your agent read the README files for design intent
1050-
- Use sample-data.json files to test before building real APIs
1051-
- Use tests.md files to guide your test-driven development
1052-
- Screenshots show target UI — use them as reference
1029+
- **Use the pre-written prompts** — They include important clarifying questions about auth and data modeling.
1030+
- **Add your own notes** — Customize prompts with project-specific context when needed.
1031+
- **Build on your designs** — Use completed sections as the starting point for future feature development.
1032+
- **Review thoroughly** — Check plans and implementations carefully to catch details and inconsistencies.
1033+
- **Fill in the gaps** — Backend business logic may need manual additions. Incremental implementation helps you identify these along the way.
10531034

10541035
---
10551036

@@ -1091,7 +1072,7 @@ Let the user know:
10911072
**Instructions:**
10921073
- `product-overview.md` — Product summary (always provide with instructions)
10931074
- `instructions/one-shot-instructions.md` — All milestones combined
1094-
- `instructions/incremental/`[N] milestone instructions (foundation, shell, sections)
1075+
- `instructions/incremental/`[N] milestone instructions (foundation, then sections)
10951076

10961077
**Design Assets:**
10971078
- `design-system/` — Colors, fonts, tokens

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,3 @@ dist/
2121
# Logs
2222
*.log
2323
npm-debug.log*
24-

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
Get notified of major releases by subscribing here:
44
https://buildermethods.com/design-os
55

6+
## [0.1.1] - 2025-12-18
7+
8+
- In the export package, consolidated '01-foundation' and '02-shell' into one.
9+
- Updated README.md tips that come in the export.
10+
611
## [0.1] - 2025-12-16
712

813
- Initial release

0 commit comments

Comments
 (0)