diff --git a/.scratch/handoffs/2026-06-06-docs-accuracy-fixes.md b/.scratch/handoffs/2026-06-06-docs-accuracy-fixes.md new file mode 100644 index 0000000..b676ab1 --- /dev/null +++ b/.scratch/handoffs/2026-06-06-docs-accuracy-fixes.md @@ -0,0 +1,56 @@ +# Handoff: уточнение документации по архитектуре + +Дата: 2026-06-06 · Язык сессии: русский + +Следующая сессия чинит профильную документацию, которая отстала от кода. Рабочий список +уже собран и сверён с кодом — **не переоткрывай его заново**, бери готовый: +[`.scratch/docs-accuracy-audit/findings.md`](../docs-accuracy-audit/findings.md) +(12 находок, разнесены по серьёзности, с привязкой файл:строка). + +## Что делать + +Чинить доки по списку аудита, **начиная с 🔴**: +- `ARCHITECTURE.md` — три концептуальных искажения: схема `ods.*_errors`, DQ-split подан + как взаимоисключающий (а строка попадает в обе таблицы), сборка `dds.event` + (browser-driven LEFT JOIN, не симметричный JOIN; «сироты» из location отбрасываются). +- `SUPERSET_DASHBOARD.md` — `make superset-export` задокументирован как рабочий, но + `export_dashboard.py` падает на устаревших импортах. **Решение за владельцем:** чинить + импорты или убрать команду из доки, если экспорт больше не нужен. +- `REPO_MAP.md` — пропущен первый шаг ETL `sql/ods/20_stg_to_ods.sql` и ряд артефактов. + +Потом 🟡 (неполнота параметров и DQ-маркеров) и 🟢 (мелочи). + +## Контекст, который сэкономит время + +- **Источник истины — код**, не доки: `sql/ddl/*`, `sql/ods|dds|dm/*`, `airflow/dags/*`, + `superset/*.py`, `docker-compose.yml`, `Makefile`. Аудит уже сослался на нужные строки. +- **Ключевой инсайт:** концептуальные темы ARCHITECTURE (DQ-split, сборка DDS с сиротами) + точнее и подробнее разобраны в **уроках 2–3 курса** (`docs/course/lessons/`). Де-факто + каноном стали уроки, а не ARCHITECTURE. Скорее всего проще подтянуть ARCHITECTURE к + формулировкам уроков, чем переписывать с нуля — и заодно проверить, что урок и код + совпадают (уроки свежие, но тоже стоит сверить). +- **Codex сейчас стоит** — параллельной записи в ветку нет, можно править ARCHITECTURE + спокойно. Но привычку держать аддитивно не теряй: `git add` только своих файлов. +- **Стиль/голос доков:** чистый литературный русский без лишних англицизмов (см. память + `plain-literary-russian`); house style осознанный (тире «—», «ё», жирное начало абзаца, + двоеточие перед списком) — линтером не правим. `ai-text-lint` гонять только на настоящие + маркеры, context `article`. +- **Проверять claim на коде, а не на глаз** — этот подход в этой сессии и вскрыл все + расхождения. + +## Состояние + +- **Ветка** `docs/advanced-clickstream-course`. Эта сессия добавила два коммита: + `ce7f03b` (корневой README переписан под менти+песочницу) и `5bd215d` (аудит в .scratch). + Корневой README трогать больше не нужно — он самостоятельно корректен (только ссылается + на доки). +- **Рабочее дерево чистое** (после коммита/пуша этой сессии). +- 🅿️ **Future, не в скоупе:** лицензия стенда (роадмап = CC BY 4.0; для кода обычно MIT — + кандидат на dual MIT + CC BY); фейк-бейдж лицензии в README уже убран. + +## Suggested skills + +- `grill-with-docs` — выверить формулировки ARCHITECTURE против доменной модели и кода, + обновляя док по ходу решений (ровно под эту задачу). +- `ai-text-lint` — прогон правок (context `article`, house style не снимать). +- `conventional-commits` — для коммитов. diff --git a/.scratch/handoffs/2026-06-06-root-readme-polish.md b/.scratch/handoffs/2026-06-06-root-readme-polish.md deleted file mode 100644 index 292a69d..0000000 --- a/.scratch/handoffs/2026-06-06-root-readme-polish.md +++ /dev/null @@ -1,68 +0,0 @@ -# Handoff: контекст для работы над документацией курса - -Дата: 2026-06-06 · Язык сессии: русский - -Следующая сессия продолжает работу над документацией. Ближайший фокус — **корневой -[`README.md`](../../README.md)**: ощущение, что он слишком инженерно-демовый и требует -более серьёзной переработки, чем косметика. Что именно с ним делать — решаем в новой -сессии. Здесь — не план задач, а контекст и понимание, чтобы войти быстро. - -## Модель курса (держать в голове при любой правке доков) - -- **Аудитория и режим.** Продвинутый менти, прошёл базу; идёт сам, ментор — на - еженедельном **созвоне** (не «сессии»). Отсюда железное требование PRD: материал - **самодостаточен**. Любой документ курса проверяю вопросом «менти поймёт это один, без - ментора рядом?». -- **Голос.** Мягкий, уровень «обзорно», термин расшифровываем на первом употреблении, - обращаемся на «ты». Правила — `docs/course/LESSON_STANDARD.md` §2/§5. -- **House style — осознанный, линтером НЕ правим:** тире «—», буква «ё», жирные зачины - абзацев, двоеточие перед списком. `ai-text-lint` гоняем только на настоящие маркеры - (канцелярит, зачины, хеджинг, negative parallelism). -- **Принципы стенда:** один паттерн на урок; данные — **малый срез** (`LIMIT=50`) ради - быстрого повторяемого прогона (`AGENTS.md`). Это не мелочь — на этом я поймал баг (см. - ниже). -- **Крючок менторства.** Тон роадмапа: «пройти можно самому — а можно с ментором, так - быстрее/понятнее/лучше», CTA в Telegram `@dementev_dev`. Эталон тона — - `~/sources/de-roadmap/README.md`. Уже зеркально внесён в `docs/course/README.md`. - -## Линза, которую я применял (и которой не хватает корневому README) - -**Mentee-first vs author-first.** `docs/course/README.md` был написан от автора — вёл -читателя в `PRD → LEARNING_PLAN → LESSON_STANDARD` (мета-доки «зачем курс»), а не в -уроки. Я переписал его **от менти**: сначала «что нужно до старта» и индекс уроков со -ссылками, авторские доки убраны в секцию «Под капотом». Корневой README сейчас — про -демо-стенд и DE-задание, **курс в нём не упомянут вообще**; он явный кандидат на ту же -линзу, но, возможно, глубже (разделить «демо-стенд» и «вход в учебный курс»). - -## Подходы, которые сработали — стоит продолжить - -- **Проверять claim на стенде/в коде, а не на глаз.** Так нашёлся баг: я сперва написал в - course/README полную загрузку `make data`, хотя все уроки и правило среза требуют - `LIMIT=50 make data`. Сверка с реальными уроками вскрыла расхождение. -- **Свежий проход после написания** ловит фактические нестыковки, не только стиль — - именно он дал ту правку. -- **Grep-линт на AI-маркеры** с поправкой на house style быстрее сплошного чтения. -- **Читать глазами целевого читателя**: где точка входа, как ходить между частями, как - стартовать с нуля. - -## Состояние (факты, которые понадобятся) - -- **Рабочее дерево:** `docs/course/README.md` изменён, **не закоммичен** — это - mentee-first редизайн + крючок менторства + правки свежего взгляда. Пользователь хочет - закоммитить его (и правку корневого README, если будет) — **после** того как - разберёмся с корневым. -- **Git:** ветка `docs/advanced-clickstream-course`, на ней **параллельно пишет Codex** - (его `bae1e02` уже лёг поверх моего `d98ae9c`). Строго аддитивно: не трогать чужие - коммиты, `git add` только своих файлов, `git fetch` перед push. **2 локальных коммита - не запушены.** -- **Сделано в этой сессии:** `d98ae9c` (финальный `ai-text-lint` по урокам 0–6, синхрон - `PRD.md` §7, уборка отработанных handoff'ов); `docs/course/README.md` переписан от - менти. Уроки 0–6 как тексты готовы и единообразны. -- **Мелочь на заметку:** корневой README (стр. 78, 238) даёт Superset-дашборд как - `/superset/dashboard/1/`, а урок 6 — по slug `ecommerce-analytics`. Стоит сверить при - правке. - -## Suggested skills - -- `ai-text-lint` — прогон правок доков на AI-маркеры (context `article`, house style не снимать). -- `conventional-commits` — для коммита.