Этот промах научил меня, что нужно смотреть на наш продукт глазами клиента. И тогда щёлкнул тот самый "выключатель". Если я создам продукт, решающий проблемы клиента, и подкреплю его профессиональной документацией, успех гарантирован.
Я также понял, что создание профессиональной, эстетичной и удобной документации — задача непростая. Но когда она выполнена правильно, документация может превратить довольных клиентов в восторженных и, в конечном счёте, увеличить доходы.
Лучшие практики создания профессиональной документации к продукту¶
Эти практики помогают создавать привлекательную, информативную и удобную документацию. Следуя этим рекомендациям, вы сможете подготовить документацию, которая превратит хорошего клиента в отличного. А отличные клиенты помогают компаниям увеличивать доходы, ведь документация — важная составляющая клиентского опыта.
1. Понимайте свою целевую аудиторию и давайте ей то, что она хочет¶
Крайне важно знать ожидания вашей аудитории. Например, предназначена ли документация для администраторов или конечных пользователей? Объём вашей целевой аудитории может потребовать технического стиля для администраторов или чётко определённых терминов и инструкций для конечных пользователей.
Лучшая практика при создании профессиональной документации — понимание ожиданий клиентов на уровне администратора или конечного пользователя. Вот некоторые методы сбора информации об аудитории:
-
Опросы и анкетирование
-
Обратная связь от предполагаемой аудитории
-
Мозговой штурм в компании
-
Анализ популярных мнений клиентов
-
Круглые столы с клиентами
2. Создавайте план документации¶
Составление плана документации помогает предвидеть потенциальные узкие места при реализации проекта. Создание документации может быть сложным, и хорошей практикой является разработка плана, который поможет предугадать проблемы в процессе работы.
Среди преимуществ создания плана документации:
-
Конкретные задачи — Аудит существующей документации для повторного использования актуальной информации в новом плане.
-
Использование шаблонов и стилей — Если документация создаётся для нового продукта, убедитесь, что она соответствует голосу и стилю отрасли, а если для существующего — придерживайтесь текущих руководств по стилю и шаблонов для обеспечения целостности бренда.
-
Документирование инструментов — Документирование используемых инструментов помогает определить и оптимизировать процесс, обеспечивая непрерывность командной работы и лучшее понимание процесса разработки документации.
3. Упрощайте документацию¶
Исследование 2016 года определило, сколько пользователей читают документацию к продукту. Результаты оказались впечатляющими: только 25% пользователей читают документацию. Исследование выявило, что нежелание читать документацию частично связано с:
-
Нетерпеливостью пользователей — С появлением моментального доступа к информации в интернете, пользователи стали менее терпеливыми в поиске ответов. Чтение документации онлайн или офлайн может быть утомительным из-за большого объёма информации.
-
Синдромом пропуска — Пользователи часто пропускают необходимую документацию и переходят сразу к основам использования продукта. Люди учатся и понимают, как работают продукты, через взаимодействие с ними, а не чтение подробных инструкций. Инструкции должны быть максимально ясными и информативными.
-
Запутанной структурой — Руководства часто написаны в формате, который трудно понять. Многие пользователи находят документацию сложной или нерелевантной своему вопросу, что вызывает разочарование. Часто компания не проводит детального исследования аудитории и не понимает, что нужно пользователю.
4. Включайте скриншоты и графическую информацию¶
Думайте о документации как о дорожной карте, рассказывающей историю о продукте. Ведите клиента по пути, который легко идентифицировать с помощью скриншотов или графики, и объясняйте, как разные элементы взаимодействуют друг с другом. Чётко объясняйте, что видит пользователь, как функция активируется, как она влияет на продукт и чего ожидать дальше. Убедитесь, что каждое изображение целесообразно и работает в общем процессе.
5. Используйте перекрёстные ссылки для более чёткого понимания тем¶
Я обнаружил, что перекрёстные ссылки неоценимы при чтении документации. Понимание того, как работает функция или процесс, значительно улучшается при наличии ссылок на связанные темы. Связывая соответствующие точки данных, пользователь получает более ясную картину взаимодействия системы и рабочего процесса.
6. Помните о принципе KISS при создании документации¶
Не забывайте использовать принцип KISS (Keep It Simple, Stupid) при создании документации. Важно тщательно документировать процесс, но не до точки избыточности. Пользователь может искать информацию по конкретным вопросам, поэтому соблюдение принципа KISS обеспечивает более лёгкую навигацию и понимание документации.
Например, для объяснения функции может быть достаточно простых заметок, возможно, со ссылкой на основную тему. Держите факты ясными и лаконичными, чтобы пользователь мог легко найти нужную информацию. Возможно, пользователю не интересно читать каждый аспект продукта.
7. Учитывайте разные стили обучения¶
Каждый человек имеет свой стиль обучения. Некоторые предпочитают подробные описания, другие — графику и визуальные представления. Есть те, кто лучше учится через практическое участие, а не сосредоточенное чтение.
Охватывайте все стили обучения при создании эффективной и информативной документации. Добавление графики, скриншотов, графиков, структурированного текста или ссылок на видео помогает обеспечить понимание документации пользователями с разными стилями обучения.
8. Персонализируйте и структурируйте контент для вводного обучения¶
Персонализируйте документацию в зависимости от роли аудитории. Создавайте разные версии документации в зависимости от ролей предполагаемой аудитории. Например, вопросы администратора могут не совпадать с вопросами опытного пользователя.
Документация может включать элемент персонализации путём создания немного разных версий, нацеленных на роль предполагаемой аудитории. Модификация контента в зависимости от роли аудитории придаёт документации персонализированный характер.
9. Чётко определяйте термины для конкретной аудитории¶
В зависимости от целевой аудитории, хорошей практикой является объяснение значения каждого термина, используемого в документации. Если аудитория внутренняя, можно использовать более сложные термины с некоторыми пояснениями. Однако когда к документации получают доступ внешние пользователи, нельзя знать уровень их знаний.
Чёткое определение уникальных или сложных терминов устанавливает гораздо лучшую и эффективную коммуникацию для всех внутренних заинтересованных сторон и внешних пользователей.
10. Предоставляйте метод сбора обратной связи от пользователей¶
Обратная связь по документации даёт ценную информацию о её эффективности. Добавьте ссылку или простую кнопку "Нравится/Не нравится" для сбора важной информации о качестве документации. Собирая обратную связь от пользователей, вы можете совершенствовать и улучшать документацию.
11. Избегайте документации с плоской структурой¶
При создании документации убедитесь, что она не написана как "плоская структура". Чтение документа, полного сплошного текста, утомительно и может стать скучным. Интерес читателя к документации повысится, если информация будет актуальной для обсуждаемой темы и её можно будет быстро усвоить.
Разбивайте сплошной текст, выделяя избранную информацию или интегрируя видео, изображения, ссылки и другие методы для обеспечения лучшего пользовательского опыта. Подавая контент документа "маленькими порциями", вы обеспечите читателю более приятный опыт, и он будет менее неохотно читать документацию.
12. Создавайте SEO-дружественную документацию¶
Лучшей практикой для онлайн-документации является написание в стиле, который дружественен к SEO. Обеспечьте, чтобы документация была написана так, чтобы максимизировать результаты поиска в интернете. Клиентам может понадобиться найти свою документацию, и когда у них нет явной ссылки на сайт размещения, при вводе поисковых терминов ответы приходят быстрее и точнее, если документация оптимизирована для поисковых систем.
13. Поддерживайте актуальность документации¶
Поддержание документации в актуальном состоянии крайне важно, особенно если она доступна онлайн. Часто требования к продукту меняются, и онлайн-документация должна отражать любые новые изменения или обновления. Пользовательская документация должна быть актуальной и обновленной с учетом последних изменений, а клиент должен быть уведомлен об изменениях в документации.
14. Учитывайте, что пользователи могут не читать документацию¶
Исследование 2014 года показало, что пользователи не полностью читают всю документацию к продукту. Основными причинами нечтения документации были:
-
Документация была слишком сложной
-
Документация не отвечала напрямую на их вопросы
-
Пользователи не использовали многие функции продукта из-за нечтения документации
-
Многие пользователи предпочитали "практическое" обучение вместо чтения документации
15. Управляйте динамическим и статическим контентом¶
Документация продукта постоянно развивается с обновлениями, новыми функциями, исправленным контентом, обновленными уведомлениями о техническом обслуживании и другими элементами. Это называется "живым документом", который постоянно развивается в соответствии с требованиями продукта.
Статический контент предоставляет пользователю данные, которые не меняются на протяжении жизни продукта. Идея статического контента — дать пользователям, особенно новым, информацию, которая остаётся неизменной на протяжении жизненного цикла продукта. Статический контент важен для полноценной документации, но обычно уступает место динамической документации.
Поддержание набора документации проще, когда контент классифицируется как динамический или статический. Документацию жизненного цикла продукта легче внедрять и проверять, когда она классифицирована по типам. Могут быть незначительные изменения в документации для новых функций (статический) или подробные обновления продукта (динамический).
16. Лучшие практики доступности документации¶
Хотя пользователи не обязательно читают большую часть документации, когда она им нужна, они хотят получить её немедленно. Традиционным методом доставки документации было печатное руководство, которое поставлялось с продуктом. Однако в современном цифровом мире документация часто предоставляется через интернет.
Независимо от способа доставки документации, важно иметь легкодоступные точки доступа. Основные методы предоставления документации сегодня:
-
Офлайн-документация — Многие продукты поставляются с печатными руководствами или листами "Быстрый старт". Эти документы обычно одноразовые и не распространяются легко. Однако многие руководства дополнительно предоставляются в формате PDF, что обеспечивает портативность или возможность печати по требованию.
-
Онлайн-документация — Каждый раз, когда вы ищете в Google ответ на проблему, вы, вероятно, получаете фрагмент онлайн-документации. Появление интернета вытеснило печатные руководства или материалы документации для конечных пользователей. Некоторые преимущества онлайн-документации:
-
Удалённая работа — Пандемия показала, что работа из дома может быть такой же продуктивной, как и в офисе, особенно когда на наши вопросы отвечает онлайн-документация.
-
Сотрудничество — С легкодоступным порталом онлайн-документации члены команды могут быстро обмениваться информацией и создавать командную работу, что часто невозможно в офисе.
-
Мобильность — Появление мобильных устройств, таких как планшеты и смартфоны, постепенно вытеснило ПК для повседневного взаимодействия. Вы можете легко получить доступ к онлайн-документации со смартфона и быстро найти решение проблемы даже в любимом кафе во время обеда.