Где документация спотыкается снова и снова: итоги техписовского бинго на Tech Writers Days
На конференции Tech Writers Days 2 мы (Документерра — платформа для технических писателей) предложили участникам немного поиграть. Не в кальмара, а в техписовское бинго: отметить на карточке те проблемы в документации, с которыми они регулярно сталкиваются на работе.
В каждой клетке — знакомая ситуация:
- «Пример? Сам придумай»
- «Никто не проверил»
- «Сначала шаг 5»
- «Где-то тут… было»
- «Никто не читает, но жалуются все»
📋 За два дня мы собрали 113 заполненных карточек. Кто-то улыбался, кто-то честно отмечал почти всё, кто-то комментировал: «Это слишком больно читать». А мы тем временем собрали статистику — и теперь делимся результатами.
📈 Что показало бинго
Вот самые часто встречающиеся пункты (число отметок в скобках):
- «Где поиск?» (78)
- «Никто не читает, но жалуются все» (74)
- «Читай между строк» (70)
- «Никто не проверил» (70)
- «404: Документ не найден» (64)
Среди менее массовых, но всё ещё болезненных:
- «Пример? Сам придумай» (25)
- «Разработчик забыл сказать» (41)
- «Форматирование сломалось» (37)
Многие анкеты сопровождались лаконичными, но выразительными комментариями: 👉 «Он в другом доке» 👉 «Релиз есть, а фичи нет» 👉 «T_T» 👉 «Х6 галочек. Это нормально?» — да, к сожалению, это нормально.
🧠 Почему это важно
Такие паттерны — не случайность. Они появляются, когда документация:
- Пишется в последнюю очередь (или уже «по следам» релиза);
- Не проходит ревью;
- Отрывается от пользовательских сценариев;
- Не имеет единого канала обратной связи.
Именно поэтому даже в командах с красивыми порталами и продвинутыми тулчейнами продолжают появляться карточки вроде «Сначала шаг 5» или «Спойлер: не дополним».
🎁 Что дальше?
📎 Полный разбор с выводами и рекомендациями — в нашей основной статье. Там же можно скачать поле бинго и использовать его:
- для командной ретроспективы,
- как чеклист при аудите техдока,
- как способ начать разговор о качестве документации.
💬 Делитесь в комментариях, сколько клеток можете честно закрыть — мы уверены, будет что обсудить.