ship-create 1.3.0 → 1.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/create.mjs +342 -167
- package/package.json +1 -1
- package/templates/.claude/commands/build.md +89 -0
- package/templates/.cursorrules +41 -24
- package/templates/.windsurfrules +41 -24
- package/templates/AGENTS.md +41 -24
- package/templates/CLAUDE.md +41 -24
- package/templates/docs/tech-stack/STACK_DECISION_MATRIX.md +288 -0
- package/templates/docs/tech-stack/TECH_STACK.md +492 -0
- package/templates/starter-kit/package.json +2 -2
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Read docs/PROJECT.md and docs/HUMAN_FLOW.md, finalize the build spec, design the UI with the ui-ux-pro-max skill, then start building the app.
|
|
3
|
+
argument-hint: "[feature name — leave blank to build the full MVP]"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are about to build this app using The SHIP Method framework. Follow these steps exactly.
|
|
7
|
+
|
|
8
|
+
Argument passed (optional feature focus): "$ARGUMENTS"
|
|
9
|
+
|
|
10
|
+
## Step 1 — Read the project docs
|
|
11
|
+
|
|
12
|
+
Read both of these files now before doing anything else:
|
|
13
|
+
- `docs/PROJECT.md` — what we're building and for whom
|
|
14
|
+
- `docs/HUMAN_FLOW.md` — how users move through the product
|
|
15
|
+
|
|
16
|
+
## Step 2 — Check docs are ready
|
|
17
|
+
|
|
18
|
+
Confirm that PROJECT.md has real content (not `[fill in]` placeholders) in:
|
|
19
|
+
- Product Vision
|
|
20
|
+
- Problem Statement (who + what problem)
|
|
21
|
+
- Target Audience (primary segment)
|
|
22
|
+
|
|
23
|
+
And HUMAN_FLOW.md has real content in:
|
|
24
|
+
- User Journey table
|
|
25
|
+
- At least one Core Screen defined
|
|
26
|
+
|
|
27
|
+
If critical sections are still blank, stop and say:
|
|
28
|
+
"Run `/ship` first — I need a complete spec to build from."
|
|
29
|
+
|
|
30
|
+
If the docs look good, proceed to Step 3.
|
|
31
|
+
|
|
32
|
+
## Step 3 — Create the build spec
|
|
33
|
+
|
|
34
|
+
Check if `docs/AI_BUILD_SPEC.md` exists.
|
|
35
|
+
|
|
36
|
+
If not, create it now by deriving the following from `docs/PROJECT.md` and `docs/HUMAN_FLOW.md`:
|
|
37
|
+
|
|
38
|
+
```markdown
|
|
39
|
+
# AI Build Spec
|
|
40
|
+
|
|
41
|
+
## Functional Requirements
|
|
42
|
+
[list the features from MVP Scope in PROJECT.md — one bullet per feature]
|
|
43
|
+
|
|
44
|
+
## Data Model
|
|
45
|
+
[derive the tables/collections from the feature list — fields, types, relations]
|
|
46
|
+
|
|
47
|
+
## API Contract
|
|
48
|
+
[list the routes/actions the app needs — method, path, what it does, who can call it]
|
|
49
|
+
|
|
50
|
+
## Auth
|
|
51
|
+
[derive from HUMAN_FLOW.md Section 5 Key UX Decisions — magic link / OAuth / password]
|
|
52
|
+
|
|
53
|
+
## Out of scope for this build
|
|
54
|
+
[copy from PROJECT.md Section 6 "Out of scope for MVP"]
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Show the spec to the user and ask: "Does this look right before I start building?"
|
|
58
|
+
Wait for confirmation before continuing.
|
|
59
|
+
|
|
60
|
+
## Step 4 — Design the UI with ui-ux-pro-max
|
|
61
|
+
|
|
62
|
+
**Invoke the `ui-ux-pro-max` skill now.** Use it to:
|
|
63
|
+
|
|
64
|
+
1. Derive a color palette and font pairing from the business described in `docs/PROJECT.md` — the product type, audience, and tone should drive the style choices.
|
|
65
|
+
2. Present 2-3 theme options to the user. Never pick silently.
|
|
66
|
+
3. Apply the chosen theme to `app/globals.css` (`:root` and `.dark` tokens) and `app/layout.tsx`.
|
|
67
|
+
4. Use the skill's component and layout guidance when building each screen in Step 5 — it knows 67 design styles, 96 palettes, and 57 font pairings, so defer to it for any UI decision.
|
|
68
|
+
|
|
69
|
+
Also read `docs/tech-stack/STACK_DECISION_MATRIX.md` for stack decisions (database, auth provider, hosting).
|
|
70
|
+
|
|
71
|
+
## Step 5 — Build
|
|
72
|
+
|
|
73
|
+
If a specific feature was passed as an argument, build that feature only.
|
|
74
|
+
If no argument was given, build the full MVP from `docs/AI_BUILD_SPEC.md`.
|
|
75
|
+
|
|
76
|
+
Build in this order:
|
|
77
|
+
1. Database schema (`lib/db/schema.*.ts`)
|
|
78
|
+
2. Server actions or API routes
|
|
79
|
+
3. Pages and components (one screen at a time, following `docs/HUMAN_FLOW.md` Section 3 Core Screens)
|
|
80
|
+
4. Replace mock data with real data layer calls
|
|
81
|
+
5. Replace the generic `app/page.tsx` ("Pick your area") with the real entry point from `docs/HUMAN_FLOW.md`
|
|
82
|
+
|
|
83
|
+
After each screen: summarize what was built and what's next.
|
|
84
|
+
|
|
85
|
+
## Rules
|
|
86
|
+
|
|
87
|
+
- Never invent business logic not in the spec — if something is unclear, ask.
|
|
88
|
+
- If a code change would conflict with `docs/AI_BUILD_SPEC.md`, flag it instead of silently overriding.
|
|
89
|
+
- After finishing, run `/ship status` to confirm nothing is outstanding before declaring done.
|
package/templates/.cursorrules
CHANGED
|
@@ -1,56 +1,73 @@
|
|
|
1
1
|
# SHIP Agent Rules
|
|
2
2
|
|
|
3
|
-
**This file is the canonical ruleset.** Copies of this exact content live at `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, and `.windsurfrules` so that whichever AI coding tool opens this repository, it picks up these rules automatically
|
|
3
|
+
**This file is the canonical ruleset for this project.** Copies of this exact content live at `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, and `.windsurfrules` so that whichever AI coding tool opens this repository, it picks up these rules automatically.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## What This
|
|
7
|
+
## What This Project Is
|
|
8
8
|
|
|
9
|
-
This
|
|
9
|
+
This project was scaffolded with **The SHIP Method** — a four-phase discipline for building products with AI:
|
|
10
10
|
|
|
11
11
|
```
|
|
12
12
|
S — STRUCTURE → H — HUMAN FLOW → I — INSTRUCTION → P — PUBLISH
|
|
13
13
|
(what & why) (the experience) (AI-ready specs) (ship it)
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
All docs live under `docs/`:
|
|
17
|
+
|
|
18
|
+
| File | Purpose |
|
|
19
|
+
|---|---|
|
|
20
|
+
| `docs/PROJECT.md` | What & why — vision, audience, problem, MVP scope |
|
|
21
|
+
| `docs/HUMAN_FLOW.md` | How users move through the product, screen by screen |
|
|
22
|
+
| `docs/AI_BUILD_SPEC.md` | Functional requirements, data model, API contract (created at build time) |
|
|
23
|
+
| `docs/tech-stack/STACK_DECISION_MATRIX.md` | How to choose databases, auth, hosting, etc. |
|
|
24
|
+
| `docs/tech-stack/TECH_STACK.md` | Full stack reference for this project type |
|
|
25
|
+
| `docs/PROMPTS.md` | Full SHIP prompt chain (Stages 1-6) for reference |
|
|
26
|
+
|
|
27
|
+
**For UI/design decisions:** invoke the `ui-ux-pro-max` skill — it provides palette, typography, component patterns, and layout guidance specific to this project type. Do not rely on generic static design files.
|
|
17
28
|
|
|
18
29
|
## Mandatory Behavior for Any AI Agent Working in This Repo
|
|
19
30
|
|
|
20
31
|
1. **Check Structure and Human Flow before generating application code.**
|
|
21
|
-
-
|
|
22
|
-
- If either is missing, or still contains unfilled `[bracket placeholders]` in its core sections (Vision, Problem Statement, MVP Scope;
|
|
23
|
-
- Exception: scaffolding,
|
|
32
|
+
- Read `docs/PROJECT.md` and `docs/HUMAN_FLOW.md` at the start of every session.
|
|
33
|
+
- If either is missing, or still contains unfilled `[fill in]` / `[bracket placeholders]` in its core sections (Vision, Problem Statement, MVP Scope; User Journey, Core Screens), **do not generate feature code**. Instead, run `/ship` to guide the user through filling the gaps.
|
|
34
|
+
- Exception: scaffolding, config files, and infra setup are fine to generate at any time — the gate is on *feature/business logic* code only.
|
|
24
35
|
|
|
25
|
-
2. **
|
|
36
|
+
2. **Use `docs/AI_BUILD_SPEC.md` as the source of truth** for functional requirements, data model, and API contract once it exists. If a user's code request conflicts with it, flag the conflict instead of silently overriding the spec.
|
|
26
37
|
|
|
27
38
|
3. **Use the right reference file for the job:**
|
|
28
39
|
| Need | File |
|
|
29
40
|
|---|---|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
41
|
+
| Vision, audience, MVP scope | `docs/PROJECT.md` |
|
|
42
|
+
| User flow, screens | `docs/HUMAN_FLOW.md` |
|
|
43
|
+
| Functional requirements, data model | `docs/AI_BUILD_SPEC.md` |
|
|
44
|
+
| Stack choice | `docs/tech-stack/STACK_DECISION_MATRIX.md` |
|
|
45
|
+
| UI/design decisions | invoke `ui-ux-pro-max` skill — derives palette, font, components from the project context |
|
|
46
|
+
| Product-type feature checklist | `docs/*_TEMPLATE.md` |
|
|
35
47
|
|
|
36
|
-
4. **After generating a new feature**, remind the user to
|
|
48
|
+
4. **After generating a new feature**, remind the user to update `docs/PROJECT.md` Section 6 (MVP Scope) if scope changed.
|
|
37
49
|
|
|
38
50
|
5. **If the user explicitly insists on skipping the gate** ("just build it, skip the docs"), comply — but say once, briefly, what's being skipped and why it usually causes rework later. Don't refuse repeatedly or lecture.
|
|
39
51
|
|
|
40
|
-
6. **Never invent business facts** (market size, pricing, real metrics, real user quotes)
|
|
52
|
+
6. **Never invent business facts** (market size, pricing, real metrics, real user quotes). Draft clearly-labeled `[TBD: ...]` placeholders or ask the user.
|
|
41
53
|
|
|
42
|
-
7. **Once the spec is complete, run the "Theme & First Screen" step before polishing or shipping.**
|
|
43
|
-
|
|
44
|
-
- **
|
|
45
|
-
-
|
|
54
|
+
7. **Once the spec is complete, run the "Theme & First Screen" step before polishing or shipping.**
|
|
55
|
+
When `docs/PROJECT.md` and `docs/HUMAN_FLOW.md` are filled and `docs/AI_BUILD_SPEC.md` exists:
|
|
56
|
+
- **Theme:** Invoke the `ui-ux-pro-max` skill. Using the business context from `docs/PROJECT.md`, derive 2-3 theme candidates (HSL color tokens + font pairing). Present them, let the user pick one, apply it to `app/globals.css` and `app/layout.tsx`. See `.claude/skills/ship-method/theme-guide.md` for a fallback business-type → palette reference.
|
|
57
|
+
- **Home:** Read `docs/HUMAN_FLOW.md`, determine the real entry point for this business, and replace the starter kit's generic `app/page.tsx` with it.
|
|
58
|
+
- Never pick a theme silently. Never require brand assets the user didn't provide.
|
|
46
59
|
|
|
47
60
|
## Quick Orientation for a New Agent Session
|
|
48
61
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
62
|
+
1. Read `docs/PROJECT.md` to learn what's being built and for whom.
|
|
63
|
+
2. Read `docs/HUMAN_FLOW.md` to understand the user experience.
|
|
64
|
+
3. Check if `docs/AI_BUILD_SPEC.md` exists — if yes, read it for the technical contract.
|
|
65
|
+
4. Then proceed with what the user asked, applying the rules above.
|
|
66
|
+
|
|
67
|
+
**Shortcut commands available:**
|
|
68
|
+
- `/ship` — interactive gate-by-gate guide through Structure → Human Flow → Instruction → Publish
|
|
69
|
+
- `/build` — assumes docs are filled, creates build spec and starts coding the MVP
|
|
53
70
|
|
|
54
71
|
## Source
|
|
55
72
|
|
|
56
|
-
|
|
73
|
+
This project was created with `npx ship-create`. The SHIP Method OS lives at github.com/nireadaddy/the-ship-method-os.
|
package/templates/.windsurfrules
CHANGED
|
@@ -1,56 +1,73 @@
|
|
|
1
1
|
# SHIP Agent Rules
|
|
2
2
|
|
|
3
|
-
**This file is the canonical ruleset.** Copies of this exact content live at `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, and `.windsurfrules` so that whichever AI coding tool opens this repository, it picks up these rules automatically
|
|
3
|
+
**This file is the canonical ruleset for this project.** Copies of this exact content live at `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, and `.windsurfrules` so that whichever AI coding tool opens this repository, it picks up these rules automatically.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## What This
|
|
7
|
+
## What This Project Is
|
|
8
8
|
|
|
9
|
-
This
|
|
9
|
+
This project was scaffolded with **The SHIP Method** — a four-phase discipline for building products with AI:
|
|
10
10
|
|
|
11
11
|
```
|
|
12
12
|
S — STRUCTURE → H — HUMAN FLOW → I — INSTRUCTION → P — PUBLISH
|
|
13
13
|
(what & why) (the experience) (AI-ready specs) (ship it)
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
All docs live under `docs/`:
|
|
17
|
+
|
|
18
|
+
| File | Purpose |
|
|
19
|
+
|---|---|
|
|
20
|
+
| `docs/PROJECT.md` | What & why — vision, audience, problem, MVP scope |
|
|
21
|
+
| `docs/HUMAN_FLOW.md` | How users move through the product, screen by screen |
|
|
22
|
+
| `docs/AI_BUILD_SPEC.md` | Functional requirements, data model, API contract (created at build time) |
|
|
23
|
+
| `docs/tech-stack/STACK_DECISION_MATRIX.md` | How to choose databases, auth, hosting, etc. |
|
|
24
|
+
| `docs/tech-stack/TECH_STACK.md` | Full stack reference for this project type |
|
|
25
|
+
| `docs/PROMPTS.md` | Full SHIP prompt chain (Stages 1-6) for reference |
|
|
26
|
+
|
|
27
|
+
**For UI/design decisions:** invoke the `ui-ux-pro-max` skill — it provides palette, typography, component patterns, and layout guidance specific to this project type. Do not rely on generic static design files.
|
|
17
28
|
|
|
18
29
|
## Mandatory Behavior for Any AI Agent Working in This Repo
|
|
19
30
|
|
|
20
31
|
1. **Check Structure and Human Flow before generating application code.**
|
|
21
|
-
-
|
|
22
|
-
- If either is missing, or still contains unfilled `[bracket placeholders]` in its core sections (Vision, Problem Statement, MVP Scope;
|
|
23
|
-
- Exception: scaffolding,
|
|
32
|
+
- Read `docs/PROJECT.md` and `docs/HUMAN_FLOW.md` at the start of every session.
|
|
33
|
+
- If either is missing, or still contains unfilled `[fill in]` / `[bracket placeholders]` in its core sections (Vision, Problem Statement, MVP Scope; User Journey, Core Screens), **do not generate feature code**. Instead, run `/ship` to guide the user through filling the gaps.
|
|
34
|
+
- Exception: scaffolding, config files, and infra setup are fine to generate at any time — the gate is on *feature/business logic* code only.
|
|
24
35
|
|
|
25
|
-
2. **
|
|
36
|
+
2. **Use `docs/AI_BUILD_SPEC.md` as the source of truth** for functional requirements, data model, and API contract once it exists. If a user's code request conflicts with it, flag the conflict instead of silently overriding the spec.
|
|
26
37
|
|
|
27
38
|
3. **Use the right reference file for the job:**
|
|
28
39
|
| Need | File |
|
|
29
40
|
|---|---|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
41
|
+
| Vision, audience, MVP scope | `docs/PROJECT.md` |
|
|
42
|
+
| User flow, screens | `docs/HUMAN_FLOW.md` |
|
|
43
|
+
| Functional requirements, data model | `docs/AI_BUILD_SPEC.md` |
|
|
44
|
+
| Stack choice | `docs/tech-stack/STACK_DECISION_MATRIX.md` |
|
|
45
|
+
| UI/design decisions | invoke `ui-ux-pro-max` skill — derives palette, font, components from the project context |
|
|
46
|
+
| Product-type feature checklist | `docs/*_TEMPLATE.md` |
|
|
35
47
|
|
|
36
|
-
4. **After generating a new feature**, remind the user to
|
|
48
|
+
4. **After generating a new feature**, remind the user to update `docs/PROJECT.md` Section 6 (MVP Scope) if scope changed.
|
|
37
49
|
|
|
38
50
|
5. **If the user explicitly insists on skipping the gate** ("just build it, skip the docs"), comply — but say once, briefly, what's being skipped and why it usually causes rework later. Don't refuse repeatedly or lecture.
|
|
39
51
|
|
|
40
|
-
6. **Never invent business facts** (market size, pricing, real metrics, real user quotes)
|
|
52
|
+
6. **Never invent business facts** (market size, pricing, real metrics, real user quotes). Draft clearly-labeled `[TBD: ...]` placeholders or ask the user.
|
|
41
53
|
|
|
42
|
-
7. **Once the spec is complete, run the "Theme & First Screen" step before polishing or shipping.**
|
|
43
|
-
|
|
44
|
-
- **
|
|
45
|
-
-
|
|
54
|
+
7. **Once the spec is complete, run the "Theme & First Screen" step before polishing or shipping.**
|
|
55
|
+
When `docs/PROJECT.md` and `docs/HUMAN_FLOW.md` are filled and `docs/AI_BUILD_SPEC.md` exists:
|
|
56
|
+
- **Theme:** Invoke the `ui-ux-pro-max` skill. Using the business context from `docs/PROJECT.md`, derive 2-3 theme candidates (HSL color tokens + font pairing). Present them, let the user pick one, apply it to `app/globals.css` and `app/layout.tsx`. See `.claude/skills/ship-method/theme-guide.md` for a fallback business-type → palette reference.
|
|
57
|
+
- **Home:** Read `docs/HUMAN_FLOW.md`, determine the real entry point for this business, and replace the starter kit's generic `app/page.tsx` with it.
|
|
58
|
+
- Never pick a theme silently. Never require brand assets the user didn't provide.
|
|
46
59
|
|
|
47
60
|
## Quick Orientation for a New Agent Session
|
|
48
61
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
62
|
+
1. Read `docs/PROJECT.md` to learn what's being built and for whom.
|
|
63
|
+
2. Read `docs/HUMAN_FLOW.md` to understand the user experience.
|
|
64
|
+
3. Check if `docs/AI_BUILD_SPEC.md` exists — if yes, read it for the technical contract.
|
|
65
|
+
4. Then proceed with what the user asked, applying the rules above.
|
|
66
|
+
|
|
67
|
+
**Shortcut commands available:**
|
|
68
|
+
- `/ship` — interactive gate-by-gate guide through Structure → Human Flow → Instruction → Publish
|
|
69
|
+
- `/build` — assumes docs are filled, creates build spec and starts coding the MVP
|
|
53
70
|
|
|
54
71
|
## Source
|
|
55
72
|
|
|
56
|
-
|
|
73
|
+
This project was created with `npx ship-create`. The SHIP Method OS lives at github.com/nireadaddy/the-ship-method-os.
|
package/templates/AGENTS.md
CHANGED
|
@@ -1,56 +1,73 @@
|
|
|
1
1
|
# SHIP Agent Rules
|
|
2
2
|
|
|
3
|
-
**This file is the canonical ruleset.** Copies of this exact content live at `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, and `.windsurfrules` so that whichever AI coding tool opens this repository, it picks up these rules automatically
|
|
3
|
+
**This file is the canonical ruleset for this project.** Copies of this exact content live at `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, and `.windsurfrules` so that whichever AI coding tool opens this repository, it picks up these rules automatically.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## What This
|
|
7
|
+
## What This Project Is
|
|
8
8
|
|
|
9
|
-
This
|
|
9
|
+
This project was scaffolded with **The SHIP Method** — a four-phase discipline for building products with AI:
|
|
10
10
|
|
|
11
11
|
```
|
|
12
12
|
S — STRUCTURE → H — HUMAN FLOW → I — INSTRUCTION → P — PUBLISH
|
|
13
13
|
(what & why) (the experience) (AI-ready specs) (ship it)
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
All docs live under `docs/`:
|
|
17
|
+
|
|
18
|
+
| File | Purpose |
|
|
19
|
+
|---|---|
|
|
20
|
+
| `docs/PROJECT.md` | What & why — vision, audience, problem, MVP scope |
|
|
21
|
+
| `docs/HUMAN_FLOW.md` | How users move through the product, screen by screen |
|
|
22
|
+
| `docs/AI_BUILD_SPEC.md` | Functional requirements, data model, API contract (created at build time) |
|
|
23
|
+
| `docs/tech-stack/STACK_DECISION_MATRIX.md` | How to choose databases, auth, hosting, etc. |
|
|
24
|
+
| `docs/tech-stack/TECH_STACK.md` | Full stack reference for this project type |
|
|
25
|
+
| `docs/PROMPTS.md` | Full SHIP prompt chain (Stages 1-6) for reference |
|
|
26
|
+
|
|
27
|
+
**For UI/design decisions:** invoke the `ui-ux-pro-max` skill — it provides palette, typography, component patterns, and layout guidance specific to this project type. Do not rely on generic static design files.
|
|
17
28
|
|
|
18
29
|
## Mandatory Behavior for Any AI Agent Working in This Repo
|
|
19
30
|
|
|
20
31
|
1. **Check Structure and Human Flow before generating application code.**
|
|
21
|
-
-
|
|
22
|
-
- If either is missing, or still contains unfilled `[bracket placeholders]` in its core sections (Vision, Problem Statement, MVP Scope;
|
|
23
|
-
- Exception: scaffolding,
|
|
32
|
+
- Read `docs/PROJECT.md` and `docs/HUMAN_FLOW.md` at the start of every session.
|
|
33
|
+
- If either is missing, or still contains unfilled `[fill in]` / `[bracket placeholders]` in its core sections (Vision, Problem Statement, MVP Scope; User Journey, Core Screens), **do not generate feature code**. Instead, run `/ship` to guide the user through filling the gaps.
|
|
34
|
+
- Exception: scaffolding, config files, and infra setup are fine to generate at any time — the gate is on *feature/business logic* code only.
|
|
24
35
|
|
|
25
|
-
2. **
|
|
36
|
+
2. **Use `docs/AI_BUILD_SPEC.md` as the source of truth** for functional requirements, data model, and API contract once it exists. If a user's code request conflicts with it, flag the conflict instead of silently overriding the spec.
|
|
26
37
|
|
|
27
38
|
3. **Use the right reference file for the job:**
|
|
28
39
|
| Need | File |
|
|
29
40
|
|---|---|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
41
|
+
| Vision, audience, MVP scope | `docs/PROJECT.md` |
|
|
42
|
+
| User flow, screens | `docs/HUMAN_FLOW.md` |
|
|
43
|
+
| Functional requirements, data model | `docs/AI_BUILD_SPEC.md` |
|
|
44
|
+
| Stack choice | `docs/tech-stack/STACK_DECISION_MATRIX.md` |
|
|
45
|
+
| UI/design decisions | invoke `ui-ux-pro-max` skill — derives palette, font, components from the project context |
|
|
46
|
+
| Product-type feature checklist | `docs/*_TEMPLATE.md` |
|
|
35
47
|
|
|
36
|
-
4. **After generating a new feature**, remind the user to
|
|
48
|
+
4. **After generating a new feature**, remind the user to update `docs/PROJECT.md` Section 6 (MVP Scope) if scope changed.
|
|
37
49
|
|
|
38
50
|
5. **If the user explicitly insists on skipping the gate** ("just build it, skip the docs"), comply — but say once, briefly, what's being skipped and why it usually causes rework later. Don't refuse repeatedly or lecture.
|
|
39
51
|
|
|
40
|
-
6. **Never invent business facts** (market size, pricing, real metrics, real user quotes)
|
|
52
|
+
6. **Never invent business facts** (market size, pricing, real metrics, real user quotes). Draft clearly-labeled `[TBD: ...]` placeholders or ask the user.
|
|
41
53
|
|
|
42
|
-
7. **Once the spec is complete, run the "Theme & First Screen" step before polishing or shipping.**
|
|
43
|
-
|
|
44
|
-
- **
|
|
45
|
-
-
|
|
54
|
+
7. **Once the spec is complete, run the "Theme & First Screen" step before polishing or shipping.**
|
|
55
|
+
When `docs/PROJECT.md` and `docs/HUMAN_FLOW.md` are filled and `docs/AI_BUILD_SPEC.md` exists:
|
|
56
|
+
- **Theme:** Invoke the `ui-ux-pro-max` skill. Using the business context from `docs/PROJECT.md`, derive 2-3 theme candidates (HSL color tokens + font pairing). Present them, let the user pick one, apply it to `app/globals.css` and `app/layout.tsx`. See `.claude/skills/ship-method/theme-guide.md` for a fallback business-type → palette reference.
|
|
57
|
+
- **Home:** Read `docs/HUMAN_FLOW.md`, determine the real entry point for this business, and replace the starter kit's generic `app/page.tsx` with it.
|
|
58
|
+
- Never pick a theme silently. Never require brand assets the user didn't provide.
|
|
46
59
|
|
|
47
60
|
## Quick Orientation for a New Agent Session
|
|
48
61
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
62
|
+
1. Read `docs/PROJECT.md` to learn what's being built and for whom.
|
|
63
|
+
2. Read `docs/HUMAN_FLOW.md` to understand the user experience.
|
|
64
|
+
3. Check if `docs/AI_BUILD_SPEC.md` exists — if yes, read it for the technical contract.
|
|
65
|
+
4. Then proceed with what the user asked, applying the rules above.
|
|
66
|
+
|
|
67
|
+
**Shortcut commands available:**
|
|
68
|
+
- `/ship` — interactive gate-by-gate guide through Structure → Human Flow → Instruction → Publish
|
|
69
|
+
- `/build` — assumes docs are filled, creates build spec and starts coding the MVP
|
|
53
70
|
|
|
54
71
|
## Source
|
|
55
72
|
|
|
56
|
-
|
|
73
|
+
This project was created with `npx ship-create`. The SHIP Method OS lives at github.com/nireadaddy/the-ship-method-os.
|
package/templates/CLAUDE.md
CHANGED
|
@@ -1,56 +1,73 @@
|
|
|
1
1
|
# SHIP Agent Rules
|
|
2
2
|
|
|
3
|
-
**This file is the canonical ruleset.** Copies of this exact content live at `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, and `.windsurfrules` so that whichever AI coding tool opens this repository, it picks up these rules automatically
|
|
3
|
+
**This file is the canonical ruleset for this project.** Copies of this exact content live at `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, and `.windsurfrules` so that whichever AI coding tool opens this repository, it picks up these rules automatically.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## What This
|
|
7
|
+
## What This Project Is
|
|
8
8
|
|
|
9
|
-
This
|
|
9
|
+
This project was scaffolded with **The SHIP Method** — a four-phase discipline for building products with AI:
|
|
10
10
|
|
|
11
11
|
```
|
|
12
12
|
S — STRUCTURE → H — HUMAN FLOW → I — INSTRUCTION → P — PUBLISH
|
|
13
13
|
(what & why) (the experience) (AI-ready specs) (ship it)
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
All docs live under `docs/`:
|
|
17
|
+
|
|
18
|
+
| File | Purpose |
|
|
19
|
+
|---|---|
|
|
20
|
+
| `docs/PROJECT.md` | What & why — vision, audience, problem, MVP scope |
|
|
21
|
+
| `docs/HUMAN_FLOW.md` | How users move through the product, screen by screen |
|
|
22
|
+
| `docs/AI_BUILD_SPEC.md` | Functional requirements, data model, API contract (created at build time) |
|
|
23
|
+
| `docs/tech-stack/STACK_DECISION_MATRIX.md` | How to choose databases, auth, hosting, etc. |
|
|
24
|
+
| `docs/tech-stack/TECH_STACK.md` | Full stack reference for this project type |
|
|
25
|
+
| `docs/PROMPTS.md` | Full SHIP prompt chain (Stages 1-6) for reference |
|
|
26
|
+
|
|
27
|
+
**For UI/design decisions:** invoke the `ui-ux-pro-max` skill — it provides palette, typography, component patterns, and layout guidance specific to this project type. Do not rely on generic static design files.
|
|
17
28
|
|
|
18
29
|
## Mandatory Behavior for Any AI Agent Working in This Repo
|
|
19
30
|
|
|
20
31
|
1. **Check Structure and Human Flow before generating application code.**
|
|
21
|
-
-
|
|
22
|
-
- If either is missing, or still contains unfilled `[bracket placeholders]` in its core sections (Vision, Problem Statement, MVP Scope;
|
|
23
|
-
- Exception: scaffolding,
|
|
32
|
+
- Read `docs/PROJECT.md` and `docs/HUMAN_FLOW.md` at the start of every session.
|
|
33
|
+
- If either is missing, or still contains unfilled `[fill in]` / `[bracket placeholders]` in its core sections (Vision, Problem Statement, MVP Scope; User Journey, Core Screens), **do not generate feature code**. Instead, run `/ship` to guide the user through filling the gaps.
|
|
34
|
+
- Exception: scaffolding, config files, and infra setup are fine to generate at any time — the gate is on *feature/business logic* code only.
|
|
24
35
|
|
|
25
|
-
2. **
|
|
36
|
+
2. **Use `docs/AI_BUILD_SPEC.md` as the source of truth** for functional requirements, data model, and API contract once it exists. If a user's code request conflicts with it, flag the conflict instead of silently overriding the spec.
|
|
26
37
|
|
|
27
38
|
3. **Use the right reference file for the job:**
|
|
28
39
|
| Need | File |
|
|
29
40
|
|---|---|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
41
|
+
| Vision, audience, MVP scope | `docs/PROJECT.md` |
|
|
42
|
+
| User flow, screens | `docs/HUMAN_FLOW.md` |
|
|
43
|
+
| Functional requirements, data model | `docs/AI_BUILD_SPEC.md` |
|
|
44
|
+
| Stack choice | `docs/tech-stack/STACK_DECISION_MATRIX.md` |
|
|
45
|
+
| UI/design decisions | invoke `ui-ux-pro-max` skill — derives palette, font, components from the project context |
|
|
46
|
+
| Product-type feature checklist | `docs/*_TEMPLATE.md` |
|
|
35
47
|
|
|
36
|
-
4. **After generating a new feature**, remind the user to
|
|
48
|
+
4. **After generating a new feature**, remind the user to update `docs/PROJECT.md` Section 6 (MVP Scope) if scope changed.
|
|
37
49
|
|
|
38
50
|
5. **If the user explicitly insists on skipping the gate** ("just build it, skip the docs"), comply — but say once, briefly, what's being skipped and why it usually causes rework later. Don't refuse repeatedly or lecture.
|
|
39
51
|
|
|
40
|
-
6. **Never invent business facts** (market size, pricing, real metrics, real user quotes)
|
|
52
|
+
6. **Never invent business facts** (market size, pricing, real metrics, real user quotes). Draft clearly-labeled `[TBD: ...]` placeholders or ask the user.
|
|
41
53
|
|
|
42
|
-
7. **Once the spec is complete, run the "Theme & First Screen" step before polishing or shipping.**
|
|
43
|
-
|
|
44
|
-
- **
|
|
45
|
-
-
|
|
54
|
+
7. **Once the spec is complete, run the "Theme & First Screen" step before polishing or shipping.**
|
|
55
|
+
When `docs/PROJECT.md` and `docs/HUMAN_FLOW.md` are filled and `docs/AI_BUILD_SPEC.md` exists:
|
|
56
|
+
- **Theme:** Invoke the `ui-ux-pro-max` skill. Using the business context from `docs/PROJECT.md`, derive 2-3 theme candidates (HSL color tokens + font pairing). Present them, let the user pick one, apply it to `app/globals.css` and `app/layout.tsx`. See `.claude/skills/ship-method/theme-guide.md` for a fallback business-type → palette reference.
|
|
57
|
+
- **Home:** Read `docs/HUMAN_FLOW.md`, determine the real entry point for this business, and replace the starter kit's generic `app/page.tsx` with it.
|
|
58
|
+
- Never pick a theme silently. Never require brand assets the user didn't provide.
|
|
46
59
|
|
|
47
60
|
## Quick Orientation for a New Agent Session
|
|
48
61
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
62
|
+
1. Read `docs/PROJECT.md` to learn what's being built and for whom.
|
|
63
|
+
2. Read `docs/HUMAN_FLOW.md` to understand the user experience.
|
|
64
|
+
3. Check if `docs/AI_BUILD_SPEC.md` exists — if yes, read it for the technical contract.
|
|
65
|
+
4. Then proceed with what the user asked, applying the rules above.
|
|
66
|
+
|
|
67
|
+
**Shortcut commands available:**
|
|
68
|
+
- `/ship` — interactive gate-by-gate guide through Structure → Human Flow → Instruction → Publish
|
|
69
|
+
- `/build` — assumes docs are filled, creates build spec and starts coding the MVP
|
|
53
70
|
|
|
54
71
|
## Source
|
|
55
72
|
|
|
56
|
-
|
|
73
|
+
This project was created with `npx ship-create`. The SHIP Method OS lives at github.com/nireadaddy/the-ship-method-os.
|