📖 Документация, которую реально читают

Знаете, какой документ в проекте читают реже всего? Тот, который написали «потому что надо». Толстый, подробный, с красивым оглавлением — и мёртвый. Потому что его никто не открывает, кроме автора. И когда новенький приходит, он всё равно спрашивает у коллег, а не лезет в документацию. Почему так — давайте разберёмся.

Потому что большинство документации пишется не для людей. Она пишется для проверяющего, для отчёта, для «ну обязаны же быть регламенты». И получается текст, который формально есть, а фактически — мёртв.

Почему документация умирает

Первая причина — пишет не тот, кто делает. Документацию часто поручают «специальному человеку», который не работает с системой напрямую. Он переписывает то, что ему объяснили, в красивую форму. Получается аккуратно — но оторвано от реальности. Через полгода документ не соответствует тому, как всё работает.

Вторая — не обновляется. Написали в год внедрения. Потом система меняется, дорабатывается, перестраивается. Документация — нет. Через два года она бесполезна. Все это знают, но никто не обновляет, потому что «некогда» и «вроде и так работают».

Третья — пишет для себя. Автор документирует то, что ему кажется важным. А читателю нужно другое: не «как устроено», а «как мне сделать мою работу». Разница огромная. Один пишет про архитектуру, другой ищет «как создать документ». Оба правы. Но второй не находит.

Что делает документацию живой

Живая документация — это не та, что написана идеально. Это та, которую открывают, когда надо что-то сделать, и находят ответ. Вот что отличает её от мёртвой.

Пишет тот, кто делает. Не «документалист», а человек, который сам работает с системой. Он знает, какие вопросы возникают, какие шаги непонятны, где люди спотыкаются. Его текст — не литература, но он правильный. Потому что написан изнутри, а не снаружи.

Обновляется по ходу. Не «раз в год большим обновлением», а по мере изменений. Изменился процесс — изменили документ. Добавили функцию — добавили описание. Документация — часть работы, а не отдельный проект.

Структурирована под задачу, а не под систему. Не «раздел Справочники → подраздел Контрагенты → пункт Создание». А «Как завести нового контрагента: три шага». Люди ищут действия, а не архитектуру. Возвращайте им действия.

Короткая и конкретная. Лучше пять строк, которые отвечают на вопрос, чем пять страниц, которые надо прочитать целиком, чтобы найти одну крупицу. Стереотип «хорошая документация — это толстая» в корне неверен. Хорошая документация — это та, которую можно прочитать за минуту.

Практичные форматы, которые работают

Не всё нужно описывать текстом. Иногда другой формат работает лучше.

• Пошаговые инструкции. «Сделай это, потом это, проверь вот это». Короткие, с конкретными шагами. Идеально для рутинных операций.
• Скринкасты. Три минуты видео, где показано, как сделать задачу, заменяют десять страниц текста. Особенно для новичков.
• Чек-листы. Для процессов, где важно не забыть шаги. Не описание, а список «отметил — сделал».
• FAQ. Сборник реальных вопросов, которые задавали люди, с ответами. Живой документ, который пополняется.

Онбординг как тест документации

Лучший способ проверить, работает ли ваша документация — посадить новичка и попросить сделать задачу, пользуясь только документами. Если он справился — документация живая. Если постоянно спрашивает — мёртвая. Это не проблема новичка. Это проблема документации. И это самый честный тест.

Вывод

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

Мёртвая документация съедает время на написание и не возвращает ничего. Живая — экономит время на вопросы, обучение, ошибки. И становится тем, ради чего её и пишут: надёжным способом передачи знаний.

#документация #проектная_команда #практика #РП #аналитика