Курс Технический менеджер продуктов · автор Stanislav Belyaev
EN RU

Качество документации

7 исходящих · 2 входящих · 9 всего связей

Карта Детали
МАСШТАБ КОМАНДЫ
Operational УЛУЧШЕНО В МОНОРЕПО УЛУЧШЕНО В РАСПРЕДЕЛЁННЫХ КОМАНДАХ

Качество документации

Качество и актуальность внутренней технической документации — один из ключевых факторов, влияющих на скорость онбординга и автономность разработчиков. Устаревшая документация хуже, чем её отсутствие, потому что вводит в заблуждение. Метрика включает наличие архитектурных описаний, ранбуков, API-документации и их регулярное обновление.

Ясность и актуальность доков. Команды с хорошей документацией в 2.4 раза чаще становятся элитными.

КОНТЕКСТ МОНОРЕПО

УЛУЧШАЕТСЯ: Весь код доступен для поиска в одном месте, создавая «живую» документацию. Кросс-командная находимость решений значительно выше.

КОНТЕКСТ РАСПРЕДЕЛЁННЫХ КОМАНД

ЗНАЧИТЕЛЬНО УЛУЧШАЕТСЯ по необходимости: Распределенные команды обязаны инвестировать в тексты, так как не могут полагаться на «коридорные разговоры».

Влияние масштаба
👤 Один / Пара (1–3)
0.2
👥 Команда (4–15)
0.5
🏢 Отдел (15–100)
0.8
🏛️ Организация (100+)
1

Передача знаний «осмосом» не работает при масштабе.

7
Влияет на
2
Зависит от

→ Влияет на

Поднятие окружения

Хорошая документация: дни → часы.

На 82% выше удержание
Brandon Hall Group / Gitpod / Multiple
Высокий КритическийРАСП
Переключение контекста

Self-service ответы снижают прерывания.

30% времени сеньоров сохранено
Stack Overflow Developer Survey 2022
Распределённые: Без self-serve документации разработчики асинхронно прерывают коллег в других TZ, создавая каскадные переключения контекста через нотификации.
Высокий КритическийРАСП
Когнитивная нагрузка

Выгружает информацию из памяти в систему.

В 2 раза надежнее
Cognitive load research
Распределённые: Нельзя спросить коллегу — он спит. Документация должна быть self-serve. Плохая документация → часы догадок → огромная когнитивная нагрузка.
Удовлетворённость разработчиков

Автономность — возможность найти ответы самостоятельно.

64% сталкиваются с силосами 5+ раз в неделю
Stack Overflow Developer Survey 2022
Высокий КритическийРАСП
PR в неделю

Хорошая документация устраняет блокирующие вопросы. Self-service ответы = непрерванная работа над PR.

30% времени senior сэкономлено
Stack Overflow / Developer productivity
Распределённые: Нельзя спросить спящих коллег. Без документации разработчики блокируются на 12-24h в ожидании ответов.
Задержка передачи (Handoff)

Хорошая документация обеспечивает самостоятельное получение контекста — разработчики не ждут, пока коллега проснётся.

Async-first требует docs-first
DORA 2022, Stack Overflow 2022
Доля AI-кода в репозитории

Лучшая документация = лучшие AI-предложения.

AI учится на документации
AI Code Generation Research

← Зависит от

Высокий КритическийРАСП
Текучка кадров

Уходящие разработчики уносят с собой tribal knowledge.

$31.5B/год потерь знаний
International Data Corp
Распределённые: Уходящие разработчики в распределенных командах уносят tribal knowledge, которое никогда не было задокументировано. Потеря знаний более серьезна, когда невозможна спонтанная передача знаний.
Качество асинхронной связи

Команды, инвестирующие в качество асинхронности, естественным образом производят лучшую документацию.

Async-first → docs-first культура
DORA 2022
Карта метрик — Stanislav Belyaev · Анализ — Anthropic Claude Opus 4.6 · Все данные проверены человеком