Мы же всё написали в документации! Почему никто не читает?

Знакомый крик души? Команда тратит недели на создание подробнейшей документации, а служба поддержки все равно завалена вопросами, ответы на которые «лежат на поверхности».

Первая мысль: «пользователи просто ленивые». Но это почти всегда не так. Чаще всего документацию не читают по трем причинам:

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

2. В ней невозможно что-либо найти. Это сплошная стена текста без внятной структуры и, что еще хуже, без поиска. Найти ответ на свой вопрос в таком документе сложнее, чем в Google. Пользователь выбирает Google.

3. Она описывает «кнопки», а не «решение проблем». Документация объясняет, что делает каждая функция, но не объясняет, как с помощью набора этих функций решить реальную бизнес-задачу.

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

Именно здесь на помощь приходит системный контент-маркетинг (в лице технических писателей). Его задача взять ваши глубокие инженерные знания и «переупаковать» их в удобный, понятный и ориентированный на пользователя продукт.

Посмотрите на свою документацию глазами нового клиента. Он сможет решить с ее помощью свою первую задачу за 5 минут?

Мы же всё написали в документации! Почему никто не читает? | Сетка — социальная сеть от hh.ru