Документация, которую вы заслужили: что говорит наше техпис-бинго

техписовское бинго

На конференции Tech Writers Days 2 стенд Документерры привлекал не только тульскими пряниками, сувенирами, но и техписовским бинго — формой, в которой неожиданно собралась вся реальность нашей профессии. Идея простая: 16 типичных ситуаций из жизни технических писателей. От классического «Никто не проверил» до философского «Читай между строк». Участники ставили галочки там, где узнавали себя или свои проекты.

Читайте также: О чём болит у техписов: честный список страданий и как с этим жить

Как проходило бинго

Результат? 113 заполненных карточек, немного слёз, много нервного смеха и настоящие инсайты. Это не просто шуточка для стенда — это мини-исследование, показывающее, где именно в документации чаще всего что-то идёт не так.

Каждый заполнял свою бинго-карту, и по итогам мы получили настоящий срез техписовской боли. Самыми часто отмечаемыми клетками стали:

  • «Где поиск?»78 галочек
  • «Никто не читает, но жалуются все»74 
  • «Читай между строк» и «Никто не проверил»по 70
  • «404: Документ не найден» – 64

Вот как выглядело поле (можно сохранить и проверить себя):

Техписовское бинго

бинго для техписов

Некоторые отмечали все 16 клеток. Мы не спрашивали, в какой компании они работают, — пожалели их менеджеров.

Что говорят данные

«Где поиск?»

Победитель по количеству отметок. Формально поиск есть почти везде — но это часто просто строка с иконкой лупы и нулевой релевантностью. Пользователь вбивает «экспорт данных» — получает статью про «отладку подключения к API». Тут и возникает закономерный вопрос: где поиск?

«Никто не читает, но жалуются все»

Классика. Документация живёт в Notion, Confluence или GitBook, где никто не знает её точный адрес. Или даже знает, но не хочет читать. Зато жалуются потом в Slack: «Почему ничего не понятно?!». И правда, как выжать пользу из документа, который не открывали?

«Читай между строк»

Это о недосказанности. Когда в тексте вроде бы всё описано, но критический шаг происходит «по умолчанию». Угадывай, догадывайся, гадай. Особенно страдают новички и внешние пользователи.

«Никто не проверил»

Одна из самых болезненных клеток, потому что говорит о полном отсутствии ревью, качества и заботы. Документация создаётся — и сразу уходит в прод. Ошибки, опечатки, устаревшие инструкции, отсутствующие параметры — всё это обнаруживает пользователь, но не команда.

Иногда причина — спешка: «мы не успеваем, надо выкладывать». Иногда — отсутствие процесса: документацию не включают в workflow. А иногда — просто отношение: «да кому вообще это нужно, кроме техписа?». В прод она уходит сырой и сразу становится чьей-то болью.

«404: Документ не найден»

Классическая боль не только техрайтера, но и любого, кто когда-либо пытался нагуглить «как оно вообще работает». Статья вроде бы была — точно помнишь, ссылку кидали в чат. А потом: 404. Или переехала. А может её переименовали в духе «финальный_финальный_v3_релизный». Или оставили заголовок без тела.

Такие ситуации случаются, когда нет контроля над структурой контента, истории изменений и адекватной навигации. Особенно часто — если документация размазана по нескольким платформам (Notion, Confluence, Markdown в репо и презентации в PDF — всё сразу, всё нигде).

«Сначала шаг 5»

Когда порядок шагов — как загадка из квеста: найди шаг 1 в приложении B, а шаг 3 вообще забыли описать, потому что «это очевидно». Нет, не очевидно. Да, это мешает.

«Разработчик забыл сказать»

Это боль, знакомая всем без исключения техрайтерам. Документация пишется постфактум, после релиза, когда автор фичи уже в отпуске или уволился. В итоге — документация, основанная на предположениях и просмотре diff-ов в гите.

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

Участники оставляли заметки на полях. Некоторые фразы из анкет хочется напечатать на футболках:

  • «Дайте peer-review, пожалуйста»
  • «Он в другом доке»
  • «Релиз есть, а фичи нет»
  • «T_T»
  • «Х6 галочек. Это нормально?»

В среднем, участники отмечали от 5 до 9 клеток.
Для многих это стало не просто развлечением, а поводом задуматься о глубине проблем.

Итоги

Это бинго начиналось как шуточная активность на стенде, но превратилось в довольно точный срез того, что болит у технических писателей чаще всего. Удивительно, как многое из этого касается не только документации, но и культуры внутри команды: подхода к коммуникации, планированию релизов, ответственности за контент.

Это не просто список фейлов. Это чеклист на ретроспективу, чтобы задать команде вопрос:
«А мы вот это точно исправили у себя?» Сохраняйте бинго, проверяйте себя.
Делитесь в комментариях нашего Telegram-канала, сколько клеток можете честно закрыть.

Нажимая кнопку, вы соглашаетесь с условиями обработки cookie-файлов и ваших данных о поведении на сайте, необходимых для аналитики. Запретить обработку cookie-файлов вы можете через настройки браузера.