Документация фронтенда Plechiki — ВКР

Многоуровневая документация для написания выпускной квалификационной работы. Уровни: L1 (обзор) → L2 (детали) → L3 (код и deep-dive).

Как пользоваться

1. Начни с INDEX (этот файл) — найди нужный раздел
2. Открой L1 (README.md раздела) — получи обзор за 2 минуты
3. Если нужны детали — перейди по ссылке в L2
4. Если нужен конкретный код — перейди в L3

Разделы

01. Архитектура и дизайн-система

Технологии, структура проекта, состояние, компоненты, стили

Уровень	Файл	Содержание
L1	01-architecture/README.md	Обзор архитектуры, слои, ключевые цифры
L2	tech-stack/README.md	Технологии и обоснование
L3	tech-stack/comparison-table.md	Сравнительные таблицы
L2	project-structure/README.md	Структура проекта
L3	project-structure/module-details.md	Детали каждого модуля
L2	state-management/README.md	Управление состоянием
L3	state-management/zustand-stores.md	Код Zustand stores
L3	state-management/tanstack-query-patterns.md	Паттерны TanStack Query
L2	design-system/README.md	Дизайн-система
L3	design-system/css-tokens.md	CSS custom properties
L3	design-system/ant-theme.md	Тема Ant Design
L2	components/README.md	Архитектура компонентов
L3	components/ui-components.md	UI-компоненты
L3	components/common-components.md	Common-компоненты
L3	components/layout-components.md	Layout-компоненты

02. Функциональность

Страницы, фичи, пользовательские сценарии

Уровень	Файл	Содержание
L1	02-features/README.md	Обзор функциональности
L2	routing/README.md	Маршрутизация
L2	auth/README.md	Аутентификация
L2	wardrobe/README.md	Гардероб
L2	outfits/README.md	Образы
L2	social/README.md	Социальные функции
L2	user-flows/README.md	Пользовательские сценарии

03. Технические решения

Offline-first, PWA, эмбеддинги, синхронизация, API

Уровень	Файл	Содержание
L1	03-technical/README.md	Обзор технических решений
L2	api-layer/README.md	API-слой
L2	offline/README.md	Offline-first
L2	sync-engine/README.md	Движок синхронизации
L2	pwa/README.md	PWA
L2	embeddings/README.md	Векторный поиск
L2	hooks/README.md	Хуки и утилиты

04. Контекст системы

Backend, ML, инфраструктура, дизайн (одноуровнево)

Файл	Содержание
system-overview.md	Обзор всей системы, C4 диаграмма
backend.md	Kotlin бэкенд, эндпоинты, ER-модель
ml-service.md	ML-классификация и эмбеддинги
infrastructure.md	k8s, CI/CD, деплой
design.md	Дизайн-концепция

---

Маппинг: раздел ВКР → что читать

Глава "Проектирование"

1. 04-context/system-overview.md → 01-architecture/README.md
2. 01-architecture/tech-stack/ → 01-architecture/project-structure/
3. 01-architecture/state-management/ → 01-architecture/components/
4. 01-architecture/design-system/

Глава "Реализация"

1. 02-features/README.md → 02-features/routing/ → 02-features/auth/
2. 02-features/wardrobe/ → 02-features/outfits/ → 02-features/social/
3. 03-technical/api-layer/ → 03-technical/offline/ → 03-technical/sync-engine/
4. 03-technical/pwa/ → 03-technical/embeddings/

Глава "Тестирование и демонстрация"

1. 02-features/user-flows/
2. 03-technical/hooks/