Руководство пользователя нужно всем IT-продуктам — новым и давно выпущенным. Куда нажать, чтобы всё заработало? Как пользоваться программой после масштабного обновления? Знакомые вопросы для любого юзера.
Рассказываем, каким бывает руководство пользователя, и как написать свой юзер-гайд по опыту WEEEK.
Что такое руководство пользователя
📌 Руководство пользователя ещё называют инструкция пользователя, документация, хелп или юзер-гайд (user guide). Это справочная цифровая библиотека, по которой можно изучать программу. Руководство пользователя входит в состав технической документации и разрабатывается техническим писателем и продуктовой командой.
Документация продуктов бывает разной, как и сами продукты. У них отличаются цели и аудитории 👇
Виды руководств пользователя
⚙️ Пошаговое руководство или «Быстрый старт»
Общее описание продукта — рассказывает, как им пользоваться
- Для кого. Для тех, кто делает первые шаги в использовании продукта
- Цель и польза. Знакомство с основными функциями продукта, чтобы дальше использовать его самостоятельно
- Форматы публикации. Текст и видеотуториалы
⚙️ Справочное руководство
Ещё его называют базой знаний пользователя, справкой, документацией или «хелпом» — как помощь. В нём подробно описываются функции и возможности продукта.
- Для кого. Для всех пользователей
- Цель и польза. В справочном руководстве описывают все возможности продукта и то, как им пользоваться
- Форматы публикации. Текст и иллюстрации — например, скриншоты, дополнительно видео или gif
⚙️ Руководство по устранению неисправностей
Это документ с перечислением всевозможных проблем, которые могут возникнуть при использовании продукта, и их решений.
- Для кого. Для всех, кто уже имеет опыт использования продукта
- Цель и польза. Помочь пользователям самостоятельно и в кратчайшие сроки решать проблемы, возникшие во время использования продукта
- Форматы публикации. Текст и видеотуториалы
⚙️ Руководство для администраторов
Вспомогательный документ, который рассказывает о работе и обязанностях администратора, политике безопасности, общих принципах и работе продукта.
- Для кого. Для администраторов компаний
- Цель и польза. Руководство помогает правильно управлять учётными записями других пользователей, выдавать им доступы к данным, помогать решать проблемы внутри продукта
- Форматы публикации. Текст
⚙️ API-документация
API — если очень просто — правила, по которым различные программы общаются между собой и обмениваются данными. Чтобы всё происходило без ошибок, нужна соответствующая документация.
- Для кого. Для внутреннего использования с фокусом на потребностях разработчиков
- Цель и польза. API-документация нужна для успешной интеграции API в проекты и полноценного использования его функций внутри системы
- Форматы публикации. Текст
Руководства такие разные, но у них много общего — структура, язык, подход к написанию.
Поэтому мы подготовили пошаговую инструкцию, как подготовить руководство пользователя и на что обратить внимание в процессе.
Как создать руководство пользователя. Опыт WEEEK
Технический писатель и автор раздела «Помощь» WEEEK Рукия Багаудин рассказала, как устроено наше руководство изнутри, и поделилась полезными инструментами, которые помогают вести и обновлять его.
Уложили ответы Рукии в пять шагов, на которые ты можешь опираться при создании собственного руководства пользователя.
Шаг 1. Определение содержания
Хелп должен последовательно рассказать о функциях и особенностях продукта. Чтобы понять, какое выстроить содержание, надо определить ключевые части продукта. На них будет основана вся дальнейшая структура документации.
К примеру, руководство пользователя в WEEEK содержит подробную информацию о пяти главных сервисах: Задачах, Базе знаний, CRM, Пользователях и Аналитике.
Определять содержание нужно в связке с продуктовой командой — с продакт-менеджером или с владельцем продукта. С таким подходом получится описать продукт так, чтобы пользователи поняли, как его использовать.
Шаг 2. Структурирование материала
Даже базовое содержание будущей документации — большая сущность. Чтобы обработать эту информацию, лучше использовать визуализацию — например, построить схему в FigJam.
Здесь нужно расширить содержание сервиса. Как это сделать? Разбить составные части продукта на более мелкие — определить разделы и статьи, которые расскажут про каждый из них.
Визуализировать структуру руководства пользователя удобно в виде дерева или ментальной карты — по нисходящей от главной части продукта к его составным частям.
💡 При визуализации лучше дать каждому блоку свой цвет — это поможет ориентироваться в структуре и видеть картину целиком:
Шаг 3. Написание и форматирование
Написание статей можно поставить на поток. Достаточно подготовить шаблон и собирать тексты как конструктор:
Следующая задача — начать писать статьи. Для этого нужно продублировать структуру схемы из FigJam на Канбан-доске. Так тексты превратятся в задачи и будет проще выстроить зависимости, назначить ответственных и соблюдать дедлайны.
Каждая колонка на Канбан-доске может относиться к разделам хелпа:
То же самое касается и самого написания статей.
Только под процессы написания надо создавать отдельную доску, чтобы на ней можно было управлять этапами. К примеру, доску «Пишем хелп». Колонки здесь соответствуют этапам работы: «К работе», «В работе», «На проверке» и «К публикации».
Ответственный перемещает задачу по доске. Когда текст готов, то его переносят в колонку «На проверке» — и так далее. Это делает процесс работы прозрачным.
Рукия Багаудин, технический писатель WEEEK
На Канбан-доске удобно декомпозировать большие задачи. Так можно повторить структуру руководства со схемы — все внутренние подразделы привязаны к родительскому. Они образуют одну сущность, будут храниться вместе и не потеряются:
Шаг 4. Ревизия и корректура
Без продуктовой ревизии и фидбека пользователей руководство останется теорией. Есть нюансы и фичи, которых технический писатель может не знать, не сразу заметить или неправильно раскрыть.
Для этого тексты должна проверять продуктовая команда — продакт-менеджер, владелец продукта или отдел контента, при условии, что он погружен в продукт.
Шаг 5. Публикация и актуализация
IT-продукты обновляются — вслед обновляется и руководство пользователя. Работы у команды будет не меньше, чем в начале создания документации: собрать обновления, найти статьи, в которых нужно изменить информацию, вновь подготовить текст и иллюстрации и опубликовать новый материал.
Чтобы это не превратилось в бессистемные телодвижения и бесконечный поток текстов, важно выработать процесс, по которому будет обновляться документация.
Вот два инструмента, которые могут упорядочить работу над актуализацией:
- Один источник информации про обновления. Это может быть общий документ в корпоративной базе знаний или отдельный чат
- Система приоритизации, выработанная вместе с продуктовой командой. Не получится обновлять все тексты разом, и будут обновления, о которых надо написать в первую очередь. Решить, что сейчас в приоритете, можно только с продакт-менеджером или владельцем продукта
Тезисы вместо всей статьи
- Руководство пользователя — справочный документ для пользователей IT-продуктов или других систем
- Руководство пользователя нужно создавать в связке с продуктовой командой — продакт-менеджером или владельцем продукта. Иначе документация превратится в бесполезный набор текстов
- Для оформления содержания и создания будущей структуры используй визуализацию — ментальная карта отлично подойдёт для этого
- Для написания руководства удобно использовать Канбан-доски — на них можно повторить всю структуру и управлять процессом создания текстов
- Для актуализации руководства пользователей лучше снова привлечь продуктовую команду — тех, кто лучше понимает требования пользователей и знает, о каких обновлениях важно рассказать в первую очередь
Подписаться 
