Add foundational documentation templates to support product design and architecture planning, including ADR, archetypes, LLM systems, dev setup, and shared modules.
This commit is contained in:
@@ -13,6 +13,8 @@
|
||||
|
||||
This document describes a phased approach you can reuse for building AI‑assisted products. Phases structure the work, assign responsibilities, and track progress.
|
||||
|
||||
> Phases and tasks are **modular**. After choosing an archetype in `/docs/archetypes.md`, delete or ignore tasks that don’t apply to your product.
|
||||
|
||||
## Phase Summary
|
||||
- **Phase 0 — Discovery & Requirements**
|
||||
- **Phase 1 — Architecture & Design**
|
||||
@@ -54,6 +56,8 @@ This document describes a phased approach you can reuse for building AI‑assist
|
||||
- `backend/architecture.md` with modules (ingestion, processing/classification, approvals, reporting, billing), queues, DB schema notes (JSONB traces, `pgvector`).
|
||||
- `backend/api-design.md` with resources/endpoints and event feed.
|
||||
- UX prototypes for key flows.
|
||||
- Initial **ADR set** in `docs/adr/` for all locked decisions.
|
||||
- Initial **repo skeleton** (`apps/web`, `apps/api`, `packages/shared`) and `docs/dev-setup.md` ready for Phase 2 coding.
|
||||
|
||||
### Typical Tasks
|
||||
- Frontend: lock App Router + Tailwind; define shell/navigation; design loading/error patterns for lists, approvals, reports.
|
||||
|
||||
Reference in New Issue
Block a user