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:
olekhondera
2025-12-12 02:31:03 +02:00
parent 5053235e95
commit c905cbb725
26 changed files with 759 additions and 65 deletions

View File

@@ -9,6 +9,8 @@ Update this file whenever you make a decision that changes the stack, scope, con
## 1. Project Context (fill in)
- **Domain / product type:** _[e.g., customer support AI, compliance assistant, content classifier]_
- **Chosen archetype:** _[AE from `/docs/archetypes.md`]_
- **Modules in scope:** _[core AI, integrations, pipeline, human feedback, reporting, billing, tenancy, events, queues]_
- **Primary users:** _[roles/personas]_
- **Key success metrics:** _[latency, accuracy, cost, adoption, etc.]_
- **Current phase:** _Phase 0 / 1 / 2 / 3 / 4_
@@ -57,3 +59,16 @@ List any intentional departures from `docs/` recommendations and why.
## 6. Change Log (optional)
- _YYYYMMDD_: _[decision summary]_
## 7. Architecture Decision Records (ADRs)
Record major decisions and their rationale in `docs/adr/`.
Example ADRs you may need:
- _ADR: modular monolith vs microservices_
- _ADR: vector storage choice (pgvector vs external)_
- _ADR: billing model/provider_
- _ADR: RAG strategy and retrieval stack_
- _ADR: auth/tenancy model_
Once accepted, link ADRs here:
- `docs/adr/0001-<title>.md`_accepted_