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

@@ -10,7 +10,7 @@
- Базовая структура документации (`/docs`) и индекс навигации.
- Папка `agents/` с примерами профилей агентов разных ролей (frontend/backend/security/test/codereview/promptengineer) и общими правилами (`RULES.md`).
- Рекомендации по архитектуре фронтенда/бэкенда, безопасности, APIдизайну и оплатам (провайдер‑агностично).
- Примеры практик: мультиарендность, очереди фоновых задач, eventлог, explainability (`reasoning_trace`) — адаптируйте под свой домен или удалите лишнее.
- Примеры модулей и практик (опционально): мультиарендность, интеграции/ингест, очереди фоновых задач, eventлог, explainability (`reasoning_trace`), биллинг — **оставляйте только то, что нужно вашему продукту**.
- Предложенный стек: Next.js (TypeScript, Tailwind, React Query/SWR) на фронте; Node.js + Express/Fastify, Prisma/Drizzle, Postgres (+опц. `pgvector`) на бэкенде; Docker для деплоя.
---
@@ -26,7 +26,12 @@
## Навигация по документации
- **Общие документы (`/docs`):**
[`docs/project-overview.md`](docs/project-overview.md) — обзор проекта (шаблон); [`docs/phases-plan.md`](docs/phases-plan.md) — план по фазам; [`docs/content-structure.md`](docs/content-structure.md) — структура контента/страниц.
[`docs/archetypes.md`](docs/archetypes.md) — продуктовые архетипы и опциональные модули;
[`docs/project-overview.md`](docs/project-overview.md) — обзор проекта (шаблон);
[`docs/phases-plan.md`](docs/phases-plan.md) — план по фазам;
[`docs/content-structure.md`](docs/content-structure.md) — структура контента/страниц.
[`docs/adr/README.md`](docs/adr/README.md) — как фиксировать архитектурные решения (ADR);
[`docs/dev-setup.md`](docs/dev-setup.md) — devsetup и команды (когда появится код).
- **Frontend (`/docs/frontend`)** — обзор, архитектура (featurefirst), UX/UI гайды, SEO/performance.
- **Backend (`/docs/backend`)** — обзор, архитектура (модульный монолит), API design, security, payment flow (провайдер‑агностично), события и вебхуки.
- **Индексы/правила:** [`DOCS.md`](DOCS.md) — индекс документации; [`RULES.md`](RULES.md) и папка [`agents/`](agents/) — правила и профили агентов.
@@ -34,7 +39,7 @@
---
## Как использовать шаблон
- **Быстрый старт:** прочитайте `docs/project-overview.md` и `docs/phases-plan.md` — адаптируйте под ваш проект.
- **Быстрый старт:** начните с `docs/archetypes.md`, выберите архетип и набор модулей, затем заполните `docs/project-overview.md` и `docs/phases-plan.md`.
- **Технический дизайн:** используйте `docs/frontend/architecture.md` и `docs/backend/architecture.md`; для API и безопасности — `docs/backend/api-design.md` и `docs/backend/security.md`; оплаты — `docs/backend/payment-flow.md` (как пример/рыбу).
- **Работа с агентами:** перед задачей проверяйте `RULES.md`; агент выбирается по описанию профилей в `agents/` (см. протокол выбора в `RULES.md`).
- **Внесение изменений:** обновляйте документы при принятии решений; для новых подсистем добавляйте файлы в `docs/` (предпочтительно — английский).