63 lines
2.0 KiB
Markdown
63 lines
2.0 KiB
Markdown
# MVP Intake Playbook
|
|
|
|
Use this before adapting an existing MVP onto this boilerplate.
|
|
|
|
## Purpose
|
|
|
|
Prevent agents from copying product code blindly. The MVP must first be decomposed into flows, roles, data, providers, ownership and runtime behavior.
|
|
|
|
## Intake Checklist
|
|
|
|
Capture the following before implementation:
|
|
|
|
- Product summary: what the MVP does in one paragraph.
|
|
- Primary user roles.
|
|
- Admin/operator roles.
|
|
- Tenant roles.
|
|
- Critical user flows.
|
|
- Data objects and ownership.
|
|
- External providers.
|
|
- Secrets and credentials.
|
|
- Background jobs.
|
|
- Browser automation or long-running work.
|
|
- Billing or usage limits.
|
|
- Existing UI surfaces.
|
|
- Must-keep behavior.
|
|
- Behavior that should become plugin-only.
|
|
- Behavior that should be removed.
|
|
|
|
## Flow Mapping
|
|
|
|
For every flow, record:
|
|
|
|
- Entry point.
|
|
- Actor.
|
|
- Preconditions.
|
|
- Data read.
|
|
- Data written.
|
|
- Provider calls.
|
|
- Sync versus async behavior.
|
|
- Success state.
|
|
- Failure state.
|
|
- UAT check.
|
|
|
|
## Boilerplate Mapping
|
|
|
|
Map each flow into:
|
|
|
|
- `apps/web/app/routes/admin*` for admin/platform management files; runtime links must use `adminPath` or admin-host helpers.
|
|
- `apps/web/app/routes/app.$tenant*` for tenant-facing usage files; runtime links must use `appPath`, `UrlUtils.getModulePath(...)`, or an equivalent host-aware wrapper.
|
|
- `apps/api/src/app.ts` under `/v1` for canonical public/service APIs and webhooks. If a `/v1` route temporarily proxies a web `internal/api` handler, record `apps/api` as the external route owner and the web handler as the temporary implementation owner until extraction lands.
|
|
- `apps/web/app/modules/<feature>` for feature-owned application logic.
|
|
- `apps/worker` and `packages/queue` for async jobs.
|
|
- `docs/feature-manifests/<feature>.json` for the integration contract.
|
|
|
|
## Output Required From Agent
|
|
|
|
Before coding, the agent should produce:
|
|
|
|
- A short MVP decomposition.
|
|
- A feature manifest draft or update.
|
|
- A list of unknowns that block safe implementation.
|
|
- An implementation plan tied to the manifest.
|