Друзья, салют!

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

Что нужно сделать перед тем, как написать инструкцию (-ии)

1. Выкинуть из головы мнение, что ваш интерфейс интуитивен и понятен, если вы не провели крутые UX-исследования и ваши UI-инженеры до этого не делали крутые сервисы на аудиторию более 100 тыс.чел. (цифра не из головы, обычно на каждые 1000 человек вы получаете 1 респонс, а 100 - это минимальное количество отзывов, чтобы адаптировать продукт)
2. Посчитать количество пользовательских ролей и количество типовых пользовательских сценариев на каждого и количество функций, которыми надо воспользоваться в рамках каждого сценария
3. Запишите свои действия в системе на видео, медленно и с остановками. Потом вам будет удобнее нарезать скрины с Видео и заодно проверить себя в правильности последовательности действий

Как не обосраться в написании инструкций (-ии)

1. Сразу определите сколько будет инструкций. Обычно пользователь может осознать от 10-20 функций за одну инструкцию (это объём до 30-50 страниц). Если помещается в одну - отлично, если нет - дробите по Ролям, если в одной роли тоже куча функционала - выпускайте инструкции на отдельные сценарии.
2. Если у вас не одна инструкция, то не дублируйте общее описание системы (назначение, цели, описание общего процесса, и остальное абстрактное) вынесите это в общий документ
3. Проверьте, что в инструкции есть наглядное пояснение, что заполнить, куда жать и что, где смотреть. Обязательно по шагам давать визуальное изображение интерфейса с указателями поверх скрина.

Как довести инструкцию (-ии) до конечного пользователя

1. Для внутренних продуктов инструкции и их крупные ревизии (например при релизе нового функционала), необходимо утверждать приказом о вводе в эксплуатацию системы (или ее крупных элементов). Закрепите обязательство пользоваться системой в соответствии с конкретными инструкциями в должностных инструкциях сотрудников
2. Разместите инструкции в самом сервисе и в корпоративном хранилище, чтобы были на максимально видном месте. Сделайте понятную навигацию по инструкциям.
3. Проводите регулярное обучение сотрудников, записывайте видео-инструкциях и чаще в них упоминайте бумажные версии инструкций, тогда есть шанс, что все будут пользоваться правильно

Написал инструкцию по инструкциям (=

Всех обнял!

p.s. у меня есть любимый контрпример дерьмовой инструкции, прикрепил к тексту!