Files
AI_template/DOCS.md
2025-11-18 03:15:04 +02:00

2.3 KiB
Raw Blame History

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/project-overview.md — goals, target users, value proposition, key flows (data ingestion, processing, human approvals, reporting, billing), non-functional requirements.
  • docs/phases-plan.md — Phase 04 plan with tasks across product, frontend, backend, infra, data/LLM.
  • docs/content-structure.md — high-level UI/content structure and page sections.

2) Frontend (/docs/frontend)

  • docs/frontend/overview.md — frontend scope, key user journeys (onboarding, data connection, approvals, reports).
  • docs/frontend/architecture.md — recommended stack and patterns (feature-first structure, data fetching, styling).
  • docs/frontend/FRONTEND_ARCHITECTURE_PLAN.md — planning notes for frontend architecture decisions.
  • 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: ingestion, processing (rules + embeddings + LLM), approvals, reporting, billing.
  • docs/backend/architecture.md — stack and module boundaries (provider-agnostic recommendations).
  • 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)