docs: документация по архитектуре, данным и деплою

Конвенции слоёв api и web, работа с БД и миграциями, тесты, деплой
миграций, а также оглавление документации и README шаблона.
This commit is contained in:
arswarog committed 2026-10-27 10:43:49 +03:00
1 parent 9d5478ddeb
commit dbd5762ecf
10 files changed
+1308 -87

No files matched your search

+56
View File
@@ -0,0 +1,56 @@
# Geo Platform
Geo Platform — рабочее пространство для управления присутствием бренда в поисковиках и генеративных
ИИ-системах (ChatGPT, Perplexity, Google AI Overviews и т. п.). Платформа помогает подготовить о
бренде структурированные, проверяемые и согласованные данные, чтобы поиск и LLM отвечали о нём
корректно. Аббревиатура GEO расшифровывается как **Generative Engine Optimization**.
## Кому подходит
- Владельцам бизнеса, которым важно, как их компанию описывают поисковики и ИИ-ассистенты.
- SEO- и контент-специалистам, отвечающим за структурированные данные, Entity Home и E-E-A-T.
- Маркетологам и агентствам, ведущим сразу несколько брендов.
- Администраторам, управляющим пользователями платформы.
## Что можно делать
- Заводить и вести карточки брендов: название, сайт, ключевые слова, статус, команда с ролями.
- Заполнять «паспорт бренда» через пошаговый мастер: юридические данные, миссия, описание, контакты,
адрес, политики.
- Автоматически генерировать JSON-LD (Organization, LocalBusiness и др.) на основе паспорта и
выгружать его для встраивания на сайт.
- Проводить NAP-аудит: сверять имя, адрес и телефон бренда во внешних справочниках, соцсетях и
сайтах отзывов, отслеживать оценку согласованности.
- Собирать Entity Home — авторитетные страницы о компании, команде, доверии и контактах со
структурированными фактами.
- Связывать бренд с Wikidata через Q-элементы, чтобы закрепить сущность в открытом графе знаний.
- Измерять GEO-видимость через LLM-метрики: как часто бренд упоминается ИИ-моделями, в каком
контексте и по каким запросам.
- Проверять технику сайта: доступность, SSL, базовые сигналы качества.
- Отслеживать историю изменений в журнале аудита — ручные правки, импорты, автосинхронизации.
- Сравнивать тарифы на витрине — она открыта и без входа, а вошедшему отмечает его текущий план.
- Смотреть свою подписку: план, его условия и дата окончания оплаченного периода.
- Администраторам — вести тарифную линейку (планы и их версии) и разбирать биллинг конкретного
пользователя в его карточке.
## Разделы интерфейса
- **Workspace** — список брендов и создание нового.
- **Brand Management** — управление одним брендом: сущности, метрики, проверки сайта, отчёты.
- **Entity Graph** — работа с данными сущности: Overview, Passport, JSON-LD, Connectors, Audit,
Entity Home, Wikidata.
- **Тарифы (`/pricing`)** — публичная витрина планов: цены и условия, доступна без входа.
- **Settings** — профиль пользователя, язык, тема, вкладка «Моя подписка» с текущим тарифом.
- **Admin** — управление пользователями (в карточке пользователя есть вкладка биллинга), тарифная
линейка («Тарифы», `/admin/plans`) и системные настройки платформы.
## Термины
- **Бренд (Brand / Project)** — основная сущность платформы, объединяет все данные компании.
- **Сущность (Entity)** — отдельный объект бренда: филиал, локация, юрлицо.
- **NAP** — Name, Address, Phone: канонические контактные данные, которые сверяются с внешними
профилями.
- **Паспорт бренда (Passport)** — структурированная анкета о компании, из которой строятся JSON-LD и
Entity Home.
- **JSON-LD** — формат структурированных данных, который читают поисковики и ИИ-модели.
- **GEO** — оптимизация под генеративные поисковые системы.