Руководства пользователя: типы, инструменты и лучшие практики

Существует множество причин, по которым пользователи не хотят читать руководства. Некоторые говорят, что они слишком длинные, или скучные, или сосредоточены на технических деталях, а не на реальных функциях — и кроме того, всегда есть YouTube с краткими инструкциями по продукту.

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

То же самое и с программными продуктами. Пользовательская документация является важной частью технической документации любой системы. И хотя его создание довольно хлопотно, вы должны предоставить своим потребителям хорошее руководство, на которое они могут положиться. В этой статье мы объясним, что это такое, рассмотрим его типы и обсудим, как писать документы, которые ваши пользователи захотят прочитать.

Навигация по статье

Что такое пользовательская документация?
Что следует учитывать перед созданием пользовательской документации
Основные компоненты пользовательской документации
Виды пользовательской документации
Краткое руководство
Инструкции по установке и настройке
Руководство пользователя
Часто задаваемые вопросы, ЧаВо или FAQ
Руководство по устранению неполадок
Интернет-база знаний
Процесс адаптации (онбординг)
Рекомендации по пользовательской документации
Инструменты для создания пользовательской документации
Шаблоны пользовательской документации

Что такое пользовательская документация?

Документация пользователя (или конечного пользователя) представляет собой пояснительные и информационные материалы, описывающие продукт, который вы создаете и доставляете конечным пользователям. По сути, пользовательская документация пишется для предоставления информации и помощи потребителям в использовании продукта.

Пользовательская документация подпадает под категорию документации продукта, в отличие от документации процесса. Подробнее об этих группах читайте в нашей подробной статье о технической документации при разработке программного обеспечения. Как видите, документация системного администратора также может быть отнесена к пользовательской документации. Однако это более технический материал, призванный помочь администраторам в обслуживании продукта, поэтому мы не будем описывать его в этой статье.

Так почему же документация так важна для пользователей? Прочитав руководство пользователя продукта, они смогут узнать:

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

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

Что следует учитывать перед созданием пользовательской документации

Создание качественной документации предполагает подготовку и принятие решений по ряду важных вопросов.

Какие типы документов вы собираетесь создавать? В каком формате? Это будет полноценное бумажное руководство или онлайн-база знаний?
Кто основные пользователи вашего продукта? Это технические специалисты или обычные люди?
А как насчет иностранных пользователей? Стоит ли переводить контент на другие языки или локализовать его?
Кто будет принимать участие в написании этой документации? Это совместная работа или задача конкретного человека? Вам нужно привлечь внешних специалистов, например, редактора или технического писателя?
Кто несет ответственность за конечный результат?
Есть ли какие-либо информационные ресурсы по продукту или придется создавать все с нуля?

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

Ответы на эти вопросы определят, что должно быть включено в документацию и как она должна быть написана.

Основные компоненты пользовательской документации

Чтобы иметь ценность, хорошая пользовательская документация для программных продуктов должна включать ряд важных элементов:

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

Пользовательская документация — это часть опыта ваших клиентов, поэтому крайне важно, чтобы она была хорошо структурированной и простой для понимания пользователями с различным техническим опытом. В конце концов, это создает имидж вашего бренда. Итак, давайте посмотрим, какие материалы могут быть предоставлены и как можно заставить их сиять.

Виды пользовательской документации

В зависимости от ваших потребностей существует несколько типов пользовательской документации, которая может быть написана отдельно или включать в себя подробное руководство пользователя. Давайте обсудим каждый из них.

Краткое руководство

Краткое руководство — это краткая версия руководства пользователя. Он более популярен, чем его полноценный родственник, потому что, как мы уже говорили, люди просто не хотят так много читать.

Краткое руководство обычно состоит из нескольких страниц с наиболее важной информацией о продукте и кратким списком инструкций по его использованию. Он создан, чтобы помочь потребителям быстро настроить и сразу начать использовать продукт.

Обычно этого недостаточно для замены полного руководства пользователя, оно скорее предоставляет базовую информацию в качестве первого шага освоения продукта (если только вы не создаете документацию для простого продукта с ограниченной функциональностью — в этом случае краткого руководства может быть достаточно для описания все характеристики.)

Практические советы:

Используйте образы. Несмотря на краткость, хорошее краткое руководство содержит иллюстрации и визуальные индикаторы, подтверждающие описания и подчеркивающие важную информацию.
Тщательно выбирайте сценарии. Опишите наиболее распространенные сценарии взаимодействия с вашим продуктом, так как в большинстве случаев вы не сможете охватить их все или подробно рассказать об устранении неполадок (не говоря уже о дополнительных советах). Хорошей идеей будет провести исследование того, как потребители планируют использовать ваш продукт, и выбрать наиболее типичные случаи.

Образцы и шаблоны для проверки:

Инструкции по установке и настройке

Руководство по установке сосредоточено главным образом на том, как установить продукт, а не на его функциях или сценариях использования. В случае программных продуктов его также называют руководством по установке, в котором должны быть описаны процедуры настройки, позволяющие подготовить систему к использованию.

Типичное руководство по установке включает в себя такие разделы, как

введение, описывающее цель этого документа, общую информацию о продукте, сведения о товарных знаках, различные заявления об отказе от ответственности и т. д.;
предустановочные или системные требования, которые объясняют, какое аппаратное и программное обеспечение необходимо для правильной работы вашего продукта. В зависимости от особенностей продукта вы также можете включить информацию о других предварительных требованиях, таких как конфигурация веб-сервера или API;
пошаговая процедура установки, в которой перечислены необходимые действия, которые пользователь должен выполнить для установки и настройки продукта;
устранение неполадок, описывающее, как исправить распространенные проблемы, с которыми пользователь может столкнуться во время установки;
процедура удаления, объясняющая пользователю, как удалить продукт; и, при необходимости,
любые приложения, содержащие дополнительную информацию (например, список используемых сокращений или соответствующую документацию).

Не существует единого универсального способа написания руководства по установке. Вы можете включать любую информацию, которая, по вашему мнению, будет полезна на начальном этапе использования вашего продукта. Это может быть так же просто, как эти краткие инструкции по установке Energy Lens. Более подробный пример можно найти в этом руководстве по установке многофункциональных принтеров.

Практические советы:

Предоставьте пошаговые инструкции. Разбейте процедуру установки на небольшие этапы, расположите информацию в логической последовательности и опишите ее по частям. Подробное объяснение наверняка будет оценено по достоинству, особенно неопытным пользователям.
Добавьте визуальный контент. Это всегда полезно. Как пошаговые инструкции, так и устранение неполадок работают лучше, если они сопровождаются скриншотами, поэтому включите иллюстрации в свое руководство. А еще лучше предоставьте обучающее видео.
Включите контрольный список. Особенно в случае установки некоторых сложных программных комплексов пригодится контрольный список, позволяющий убедиться в том, что настройка прошла успешно и все элементы были установлены правильно.

Образцы и шаблоны для проверки:

Руководство пользователя

Руководство пользователя или инструкция пользователя — самый известный вид пользовательской документации. Он содержит максимально полную информацию о товаре и зачастую состоит из разделов, которые мы описываем отдельно. В любом случае, вот что оно обычно включает:

титульный лист (часто с информацией об авторских правах),
предисловие, описывающее, как пользоваться руководством,
оглавление,
обзор цели,
раздел аудитории, определяющий вероятных пользователей продукта (и, по сути, читателей руководства),
раздел объема работ (часто служит заявлением об отказе от ответственности),
обзор основных функций и руководство по их использованию,
раздел устранения неполадок,
раздел FAQ (часто задаваемые вопросы),
контактные данные и место, где можно получить дополнительную информацию или помощь, а также
глоссарий и/или указатель.

Руководство пользователя — это единственный источник достоверной информации о вашем программном обеспечении, поэтому убедитесь, что оно максимально полное и подробное. Обратите внимание, что он создан не только для новых пользователей, но и для тех, кто хочет узнать больше о функциях.

Практические советы:

Ограничьте справочную информацию. Большинство людей никогда не прочтут описание вашей компании или юридические заявления об отказе от ответственности. Мы понимаем, что это важная часть документации, но стараемся сделать ее максимально краткой.
Разбиения на мелкие блоки. Многочисленные особенности сложных систем необходимо описывать отдельно. Разбейте свой контент на логические разделы, посвященные различным аспектам или функциям вашего продукта.
Сделайте это онлайн. Если говорить о том, как работает программное обеспечение, пользователи, скорее всего, будут искать информацию в Интернете. Кроме того, веб-контент дешевле публиковать и его гораздо проще обновлять. Поэтому, даже если вам нужно распечатать руководство, обязательно предоставьте его онлайн-копию или базу знаний, где ваши клиенты или внутренние пользователи смогут найти необходимую информацию.
Рассмотрите возможность создания нескольких версий. Иногда с программными системами для бизнеса случается, что разным группам пользователей могут потребоваться разные руководства. В этом случае вам, возможно, придется создать несколько версий руководств пользователя, описывающих различные функциональные возможности или аспекты. Например, вы можете сделать руководство для сотрудников со стандартным обзором функционала, руководство для управленческой команды, которая будет иметь доступ к большему количеству функций, руководство для системных администраторов и руководство для разработчиков.

Образцы и шаблоны для проверки:

Часто задаваемые вопросы, ЧаВо или FAQ

FAQ означает «Часто задаваемые вопросы», и это просто список распространенных вопросов, которые могут возникнуть у людей при использовании вашего продукта. И, конечно же, ответы (если вы действительно хотите помочь своим клиентам и облегчить работу службы поддержки).

Практические советы:

Исследуйте своих пользователей и рынок. Вам нужно выбрать наиболее распространенные вопросы, на которые нужно ответить, поэтому лучший способ определить их — задать вопросы пользователям и собрать их отзывы. Если вы создаете раздел часто задаваемых вопросов для существующего продукта, поговорите с членами вашей службы поддержки. У них наверняка будут пять самых главных вопросов, которые им уже надоели. Вы также можете изучить рынок и перенять пару идей у конкурентов.
Ограничьте количество вопросов. Выберите 5-10 самых популярных вопросов, которые задают ваши пользователи, и дайте короткие и лаконичные ответы. Не делайте FAQ слишком длинным, так как это затруднит поиск необходимой информации.
Классифицируйте вопросы и включите параметры навигации. Если у вас есть еще вопросы, которые вы хотели бы выделить, рассмотрите возможность их группировки в несколько категорий, чтобы облегчить навигацию и/или добавить панель поиска.
Дайте ссылки. Вы также можете добавить ссылки на более подробное объяснение в соответствующем разделе руководства пользователя или на своем веб-сайте.

Образцы и шаблоны для проверки:

Руководство по устранению неполадок

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

Руководство по устранению неполадок должно содержать решения наиболее типичных проблем, с которыми могут столкнуться ваши пользователи при взаимодействии с вашим продуктом.

Практические советы:

Проведите исследование. Исследования так же важны для руководства по устранению неполадок, как и для раздела часто задаваемых вопросов, поскольку вам нужно найти наиболее распространенные проблемы и предложить решения. Вы можете обратиться к своей команде контроля качества, поскольку эти ребята наверняка знают, что может выйти из строя или вызвать проблемы. Проверьте рынок и посмотрите на аналогичные продукты в поисках идей. Если вы создаете документацию для существующего программного обеспечения, расспросите пользователей об их трудностях. И группа поддержки, конечно.
Предоставьте все решения, даже самые очевидные. В хорошем руководстве по устранению неполадок будут перечислены все возможные причины типичных проблем, а также четкие шаги по их устранению и восстановлению нормального функционирования. Это может быть так же просто, как совет проверить, подключен ли ваш компьютер к розетке и включен (люди делают ошибки и упускают из виду некоторые вещи, поэтому не стесняйтесь включать в свое руководство такие, казалось бы, очевидные действия).
Включите изображения. Опять же, очень эффективно добавлять визуальные эффекты с возможными уведомлениями об ошибках вместо того, чтобы объяснять, как они выглядят.
Добавьте контактные данные. После перечисления всех распространенных проблем, возможных причин и возможных решений предоставьте контактную информацию своей службы поддержки. Иногда людям просто нужно поговорить.

Образцы и шаблоны для проверки:

Руководство по устранению неполадок и обслуживанию ПК.
Руководство по устранению неполадок OpManager (ссылка для скачивания).

Интернет-база знаний

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

База знаний — это своего рода онлайн-библиотека, в которой хранится информация о конкретной теме, услуге, продукте и т. д. Если говорить о программной системе, то база знаний будет представлять собой структурированный набор данных, который будет информировать пользователей о вашем продукте, давать ответы на возможные вопросы и оказать другую помощь.

База знаний может содержать различные материалы, такие как

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

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

Базы знаний можно создавать с помощью программного обеспечения для управления знаниями (также известного как системы управления контентом), такого как Document 360 , Wix Answers или Zendesk. Такие специализированные инструменты могут помочь вам управлять своим контентом, создать внутренний или клиентский портал самообслуживания или форум сообщества и отслеживать их эффективность.

Практические советы:

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

Образцы и шаблоны для проверки:

Процесс адаптации (онбординг)

Адаптация пользователя или процесс адаптации — это знакомство пользователей с приложением или программой, показ им и объяснение того, как оно работает. Это не традиционная документация, но она становится необходимостью, если мы говорим о разработке и выводе на рынок цифровых продуктов.

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

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

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

Некоторые инструменты, которые могут помочь вам в разработке процессов адаптации, — это Helppier, Whatfix, WalkMe и плагин Joyride.

Практические советы:

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

Образцы и шаблоны для проверки: Apptimize UXCam

Рекомендации по пользовательской документации

Вот еще идеи о том, как написать отличную документацию, которая облегчит жизнь вашим пользователям.

Сделайте так, чтобы было легко читать и понимать. Это первый и самый важный совет. Не все ваши пользователи могут быть настолько подкованы в технологиях, как вы думаете, и, опять же, люди не любят слишком много читать. Поэтому сделайте все возможное, чтобы ваша документация была как можно более понятной, чтобы удержать внимание читателей.

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

Будьте кратки. Краткое письмо – это хорошее письмо. Постарайтесь найти баланс между краткостью и описательностью. Содержание должно быть коротким, но включать всю важную информацию.

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

Сохраняйте логическую последовательность и структуру. Создайте разумную иерархию заголовков и подзаголовков, чтобы четко определить, о чем каждый раздел. Кроме того, расположите свой контент в логическом порядке, например, начните с требований, затем инструкций по настройке, основных функций, более продвинутых функций и т. д.

Будьте последовательны в стиле. Даже если в создании документации участвуют несколько человек, используйте шаблоны или унифицированные схемы, чтобы сохранить одинаковую структуру и дизайн. Также неплохо привлечь редактора для работы над стилем контента.

Обратите внимание на дизайн. Чтобы документация была легко читаемой и понятной, необходимо выбрать правильный дизайн. Вы можете прочитать наши статьи об информационной архитектуре, чтобы понять, насколько важен хороший макет.

Кроме того, это отличный шанс повысить узнаваемость вашего бренда. Поэтому, если у вас есть уникальный стиль дизайна для вашей компании, обязательно используйте его.

Используйте изображения. Мы не хотим показаться заезженной пластинкой, но это действительно работает. Люди воспринимают визуальный контент гораздо быстрее и легче, чем текст. Инструкция, сопровождаемая изображением, позволит пользователям понять идею за считанные секунды, вместо того, чтобы читать длинное описание процедуры.

Поэтому включите в свою документацию изображения, снимки экрана, диаграммы, графику и видео. Также рассмотрите возможность добавления значков и цветных индикаторов, чтобы выделить наиболее важную информацию или поддержать структурное разделение.

Включить навигацию. В современном быстро меняющемся мире люди не хотят тратить время на поиск того, что им нужно, по всему тексту. Поэтому крайне важно помочь им быстро найти необходимую информацию.

Некоторые из способов навигации включают в себя:

оглавление,
панель поиска,
интуитивная категоризация,
четкие заголовки и
перекрестные ссылки.

В онлайн-материалах убедитесь, что пользователи могут легко перемещаться между разделами, а также между уровнями иерархии. Вы можете реализовать хлебные крошки, гамбургер-меню и другие приемы UX-дизайна для поддержки пользовательского потока.

Включить ссылки. В случае с онлайн-документацией или базами знаний добавление ссылок — хороший способ избежать чрезмерных описаний и просто перенаправить читателей на другую страницу, где они смогут изучить больше, если им интересно. Вы также можете предоставить ссылки на часто задаваемые вопросы, пользовательские форумы и другие источники соответствующей информации.

Следите за ошибками. Будьте осторожны с примерами кода, сообщениями об ошибках и другими снимками экрана, которые вы включаете в свою документацию. Тщательно протестируйте все функции, прежде чем описывать их в руководстве.

Часто обновляйте. Очень важно поддерживать вашу пользовательскую документацию в актуальном состоянии. Любая новая функция или изменение функционала — повод немедленно обновить ваши материалы. С печатными руководствами это сделать сложнее, но если у вас есть, скажем, онлайн-база знаний, вы должны следить за тем, чтобы она всегда была точной и актуальной.

Обеспечьте доступность. Учитывайте ограничения групп пользователей с ограниченными возможностями (например, дальтоников, слабовидящих и т. д.). Некоторые из способов удовлетворить их потребности — использовать содержательные гиперссылки, подписи, понятные заголовки, альтернативный текст изображениям и т. д. Дополнительную информацию можно найти в Руководстве по обеспечению доступности веб-контента (WCAG 2.0 AA), разработанном Консорциумом Всемирной паутины (W3C).

Сделать глоссарий. Поскольку мы говорим о программных продуктах, скорее всего, в ваших руководствах будут встречаться некоторые технические термины, которые потребуют пояснений. Не оставляйте своих нетехнических пользователей позади — предоставьте им глоссарий, в котором описываются значения всех сложных терминов, сокращений, концепций и т. д.

Разрешить повторение контента. Ничего страшного, если информация пересекается. Мы уже упоминали, что некоторая документация может быть создана отдельно или в составе, например, руководства пользователя. Кроме того, одна и та же информация может быть размещена в разных разделах. Никогда не знаешь, что на самом деле прочитают ваши пользователи, поэтому не стесняйтесь включать наиболее важные детали, меры предосторожности или инструкции в несколько мест.

Привлекайте профильных экспертов. Насколько хорошо вы знаете свой продукт? И насколько хорошо ваша команда разработчиков знает об этом? Во многих случаях заинтересованные стороны и технические специалисты осведомлены о различных аспектах продукта (например, бизнес, функциональные или технические).

Поэтому зачастую полезно иметь эксперта в данной области, который будет знать всю систему изнутри и сможет дать наиболее полное и точное описание. Это может быть менеджер проекта или продукта , или кто-то из технической команды, который знает, какого черта здесь делается.

Тестируйте и улучшайте. Подготовив документацию, протестируйте ее на реальных пользователях, чтобы убедиться, что она соответствует своей цели и помогает потребителям использовать ваш продукт. Для достижения наилучших результатов привлекайте разных людей, включая ваших сотрудников, разработчиков или инженеров, работавших над продуктом, внешних пользователей, впервые знакомых с вашим продуктом, и людей с ограниченными возможностями. Соберите их отзывы и при необходимости улучшите свою пользовательскую документацию.

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

Инструменты для создания пользовательской документации

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

Сегодня существует огромное разнообразие специализированных инструментов, которые значительно упрощают создание и обслуживание документов. Если вы занимаетесь разработкой программного обеспечения, возможно, вы уже используете или, по крайней мере, знакомы с платформами для написания технической документации. Они могут быть общего назначения для управления всей проектной документацией или узконаправленными для создания конкретных документов.

Здесь мы будем говорить только об инструментах, которые помогут вам с пользовательской документацией. Мы уже упоминали системы управления контентом — и это то, что вам нужно. Такие платформы обычно имеют множество полезных функций, облегчающих создание документов:

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

Современные программные средства документирования и системы управления контентом предлагают надежную функциональность и удобный интерфейс, поэтому выбор за вами. Вот несколько популярных платформ, которые вы можете рассмотреть для внедрения.

Confluence от Atlassian и Bit — это многофункциональные инструменты, позволяющие хранить и управлять всеми видами технической документации в одном месте, а также поддерживать совместную работу команды.
ClickHelp , Adobe RoboHelp и MadCap Flare — это комплексные инструменты управления контентом, которые помогают создавать разнообразную документацию по продукту как для онлайн, так и для оффлайн форматов вывода.
Document360 , ProProfs Knowledge Base и Helpie Knowledge Base в основном ориентированы на создание онлайн-справочных платформ и баз знаний.
Helppier, Whatfix, WalkMe и Joyride можно использовать для разработки потоков адаптации пользователей.

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

Шаблоны пользовательской документации

Как мы уже говорили, для составления качественной пользовательской документации необходимо следовать определенным правилам, прилагать усилия и проводить исследования. По мере прохождения процесса создания мы советуем вам использовать примеры других компаний и готовые шаблоны, чтобы выбрать наиболее подходящий стиль для вашего продукта. Мы предоставили образцы и шаблоны в соответствующих разделах, поэтому здесь мы просто перечислим их еще раз все вместе.

Вот несколько кратких руководств по началу работы, а также шаблонов и примеров кратких справочных руководств. Кроме того, в качестве примера вы можете просмотреть онлайн-версию краткого руководства по началу работы, Краткое руководство по началу работы с Nautilus, Краткое руководство по работе с платформой Kaya или ссылку для скачивания на Краткое руководство по началу работы с MS Word.

При создании руководства по установке вы можете просмотреть этот или загружаемый шаблон установки. Кроме того, в качестве примеров можно привести руководство по настройке eZ Flow и руководство по установке Designer.

Чтобы найти шаблоны руководств пользователя , вы можете посетить TemplateLab (их там много), просмотреть примеры руководств пользователя на SampleTemplates или загрузить редактируемый шаблон руководства MS Word, предоставленный Instrktiv.

Чтобы создать руководство по устранению неполадок, воспользуйтесь этим шаблоном, а также реальным примером руководства по устранению неполадок и обслуживанию ПК.

Качество вашей пользовательской документации может повлиять на успех внедрения программного обеспечения и качество обслуживания клиентов при использовании вашего продукта. Итак, если вы хотите, чтобы ваши руководства были полезны вашим клиентам и/или членам команды, уделяйте им должное внимание и создавайте контент, который пользователям будет интересно читать.