У большинства команд есть база знаний и почти у всех она не работает. Её пишут, обновляют, переносят в Confluence, а потом туда просто перестают заходить. И дело не в людях. Дело в том, как всё это устроено.
Давайте разберёмся.
1. В ней невозможно что-то найти
Знакомая ситуация: открываешь базу знаний — и не понимаешь, куда идти.
Страницы лежат как попало: дубли, устаревшие инструкции, странная логика разделов. В какой-то момент проще спросить коллегу, чем искать самому.
🍏 Что делать
Строить структуру не «как получилось», а под реальные задачи.
Например:
- как настроить
- как исправить
- как это работает
2. Она написана не для людей
Часто тексты выглядят примерно так: «В рамках реализации функциональности необходимо осуществить…»
И на этом всё — страницу закрывают.
🍏 Что делать
Писать так, как люди реально думают и ищут, чем проще — тем лучше.
3. Ей не доверяют
Достаточно один раз наткнуться на устаревшую инструкцию и человек больше туда не вернётся. Доверие к базе знаний теряется очень быстро.
🍏 Что делать
- регулярно обновлять ключевые статьи
- удалять устаревшее
- явно показывать, что информация актуальна
4. Она живёт отдельно от работы
База знаний сама по себе, работа — сама по себе. Задачи в Jira, обсуждения в Slack, код в репозитории — а документация где-то. Неудивительно, что её игнорируют.
🍏 Что делать
Встраивать документацию в процессы:
- добавлять ссылки в задачи
- использовать шаблоны
- делать её частью обязательных шагов
5. Её делают «для галочки»
Самая неприятная причина. Базу знаний создают, потому что «так надо», а не потому что она реально помогает. В итоге она вроде есть, но пользы от неё ноль.
Что в итоге
База знаний не работает не потому, что люди ленятся.
А потому что:
- ей неудобно пользоваться
- ей не доверяют
- она не помогает решать задачи
Хорошая документация — это не архив. Это рабочий инструмент и если им неудобно пользоваться, то им просто не будут пользоваться.