56 lines
2.9 KiB
Markdown
56 lines
2.9 KiB
Markdown
# Project Documentation Index: Starter Template
|
||
|
||
Technical index for developers and AI agents. Use this as the entry point to all `docs/` files.
|
||
|
||
---
|
||
|
||
## Documentation Languages
|
||
- Technical docs: English (`docs/` and subfolders).
|
||
- Repository summary: `README.md` (Russian).
|
||
New documents should be added in English unless noted.
|
||
|
||
---
|
||
|
||
## Documentation Structure (root: `docs/`)
|
||
|
||
### 1) General Project Docs
|
||
- `docs/archetypes.md` — product archetypes and optional modules; pick what applies.
|
||
- `docs/project-overview.md` — goals, target users, chosen archetype, key flows (pick relevant), non-functional requirements.
|
||
- `docs/phases-plan.md` — Phase 0–4 plan with tasks across product, frontend, backend, infra, data/LLM.
|
||
- `docs/content-structure.md` — high-level UI/content structure and page sections (archetype‑specific examples).
|
||
- `docs/dev-setup.md` — local/CI setup once code exists.
|
||
|
||
### 1c) Architecture Decision Records (`/docs/adr`)
|
||
- `docs/adr/README.md` — how ADRs work.
|
||
- `docs/adr/0000-template.md` — ADR template.
|
||
|
||
### 1b) LLM / AI System (`/docs/llm`)
|
||
- `docs/llm/prompting.md` — prompt structure, versioning, output schemas.
|
||
- `docs/llm/evals.md` — evaluation strategy, datasets, regression gates.
|
||
- `docs/llm/safety.md` — privacy, injection defenses, `reasoning_trace` policy.
|
||
- `docs/llm/caching-costs.md` — caching layers, budgets, monitoring.
|
||
- `docs/llm/rag-embeddings.md` — RAG/embeddings design and evaluation.
|
||
|
||
### 2) Frontend (`/docs/frontend`)
|
||
- `docs/frontend/overview.md` — frontend scope and key user journeys (depends on archetype/modules).
|
||
- `docs/frontend/architecture.md` — **canonical, locked frontend decisions** (after Phase 1).
|
||
- `docs/frontend/FRONTEND_ARCHITECTURE_PLAN.md` — working architecture notes; **archive/delete after Phase 1**.
|
||
- `docs/frontend/ui-ux-guidelines.md` — UX/UI guidance for data review and approval flows.
|
||
- `docs/frontend/seo-performance.md` — performance and SEO recommendations.
|
||
|
||
### 3) Backend (`/docs/backend`)
|
||
- `docs/backend/overview.md` — backend scope (integrations, AI capability, optional pipelines/approvals/billing).
|
||
- `docs/backend/architecture.md` — **canonical, locked backend decisions** (after Phase 1).
|
||
- `docs/backend/api-design.md` — API resources and conventions (entities, rules, approvals, reports, billing, events).
|
||
- `docs/backend/security.md` — authN/Z, secret handling, webhook verification, audit/event logging.
|
||
- `docs/backend/payment-flow.md` — payment integration (provider-agnostic template; single source of truth for payment flows and webhooks).
|
||
|
||
---
|
||
|
||
## How to Use This Index
|
||
- **New to the project:** read `project-overview.md` and `phases-plan.md` first.
|
||
- **Designing features:** use frontend/backend architecture docs plus API/security/payment flow specs.
|
||
- **Expanding docs:** add new English `*.md` files under `docs/` and update this index with links.
|
||
|
||
**Last Updated:** Phase 0 (Planning)
|