Этот промах научил меня тому, что я должен смотреть на наш продукт через призму клиента. Затем щелкнул пресловутый выключатель. Если я представлю продукт, который решает болевые точки клиента, а затем поддержу его профессиональной документацией по продукту, то у нас будет победитель.
И я также обнаружил, что создание профессиональной, эстетически привлекательной и легко читаемой документации по продукту - задача не из легких. Но если все сделано правильно, документация по продукту может привести в экстаз счастливых клиентов и в конечном итоге увеличить доходы.
Каковы лучшие методы создания профессиональной документации по продуктам?
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_PAtUEFouRAqhgcvnJ/809d42be-d04c-76b1-7895-4348b612a22dbrooke_cagle__uhvrvdr7pg_unsplash1.jpg)
Эти лучшие практики позволяют создавать эстетически привлекательную, информативную и простую в использовании документацию по продуктам. Следуя этим рекомендациям, вы сможете создать документацию по продукту, которая превратит хорошего клиента в отличного. А хорошие клиенты в конечном итоге помогают компаниям увеличить доходы, при этом документация по продукту является жизненно важным компонентом клиентского опыта.
1. Поймите свою целевую аудиторию и дайте ей то, что она хочет.
Очень важно [знать, каковы ожидания вашей аудитории] (https://www.stickyminds.com/article/writing-requirements-documentation-multiple-audiences). Например, документация по продукту предназначена для администраторов или конечных пользователей? Сфера охвата вашей целевой аудитории может потребовать написания технической документации для администраторов или в четко определенных терминах и инструкциях для конечного пользователя.
Лучшей практикой для создания профессиональной документации по продукту является понимание ожиданий клиента на уровне администратора или конечного пользователя. Некоторые из методов сбора информации об идентифицирующей аудитории следующие:
-
Анкеты и опросы
-
Воспринимаемая обратная связь с аудиторией
-
Мозговой штурм компании
-
Отзывы о популярных мнениях клиентов
-
Круглый стол для клиентов
2. Создайте план документации в качестве лучшей практики
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_OpuMo68fDe86GImec/3a718347-9b9e-c209-a4ca-c923253bf756kaleidico_26mjgncm0wc_unsplash.jpg)
Написание плана документации может помочь увидеть любые потенциальные узкие места во время реализации проекта. Создание документации по продукту может быть сложной задачей, и лучшей практикой является создание плана документации, который поможет предвидеть проблемы, которые могут возникнуть в процессе документирования.
Среди преимуществ создания плана документации можно выделить следующие:
-
Деятельные пункты - Аудит существующей документации с целью извлечения применимой информации, которая может быть повторно использована в новом плане документации продукта.
-
Соблюдение шаблонов и руководств по стилю - Если документация по продукту предназначена для нового продукта, убедитесь, что она остается в рамках голоса и стиля отрасли, или если документация относится к существующему продукту, поддерживайте текущие руководства по стилю и шаблоны, чтобы убедиться в непрерывности бренда.
-
Инструментарий процесса документирования - Инструментарий документирования может определить и оптимизировать процесс документирования продукции, обеспечивая непрерывность работы команды и лучшее понимание процесса разработки документов.
3. Упрощение документации по продуктам как лучшая практика
В 2016 году было проведено исследование, чтобы определить, сколько пользователей читают документацию по продукту. Результаты были ошеломляющими, поскольку выяснилось, что только [25% пользователей не читают документацию по продукту] (https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false). Исследование показало, что конечные пользователи не читают документацию по продукту отчасти из-за следующего:
-
Пользователи нетерпеливы - С появлением мгновенной информации через Интернет пользователи обычно становятся менее терпеливыми в поиске ответов на свои проблемы. Чтение документации по продукту онлайн или офлайн может быть трудоемким из-за большого количества информации, необходимой для конкретного продукта.
-
Синдром проскальзывания вперед - Пользователи часто пропускают необходимую документацию по продукту и сразу переходят к основам использования продукта. Пользователи учатся и понимают, как работает продукт, взаимодействуя с ним, а не читая подробные инструкции. Инструкции должны быть максимально понятными и информативными.
-
Непонятное расположение и структура - Руководства часто написаны в формате, который трудно понять и следовать ему. Многие пользователи находят документацию к продукту запутанной или не относящейся к их вопросу, разочаровываются и не хотят читать руководство. Часто компания не провела детального исследования аудитории и не смогла правильно понять, что нужно пользователю, и он слишком запутался, чтобы дочитать до конца.
4. Включите скриншоты и графическую информацию
Думайте о документации по продукту как о дорожной карте, рассказывающей историю о продукте. Ведите клиента по пути, который легко обозначить с помощью скриншотов или других графических изображений (https://theideanest.ca/5-types-graphics/?doing_wp_cron=1666462401.5462460517883300781250), и объясните, как каждое изображение взаимодействует с другим. Четко объясните, на что смотрит пользователь или когда активируется та или иная функция, как она реагирует на продукт и чего ожидать дальше. Убедитесь, что каждая графика имеет определенную цель и что рабочий процесс продукта взаимодействует друг с другом.
5. Используйте перекрестные ссылки для более точного понимания тем.
Я обнаружил, что перекрестные ссылки неоценимы при чтении документации по продукту. Понимание того, что делает функция или функциональный процесс, очень помогает при использовании перекрестных ссылок на связанную тему. Кроме того, при перекрестном связывании связанных точек данных общая картина становится более очевидной в отношении взаимодействия системы и рабочего процесса.
6. Помните принцип KISS для документации продукта.
Не забывайте использовать принцип [KISS (Keep It Simple, Stupid) при создании документации] (https://www.wrike.com/blog/understanding-kiss-principles-project-management/#What-does-KISS-stand-for). Тем не менее, важно тщательно документировать процесс, но не до такой степени, чтобы документация была излишней. Кроме того, пользователь документации может искать определенную информацию по конкретным пунктам, поэтому соблюдение принципа KISS позволяет значительно упростить навигацию и понимание документации.
Например, для объяснения функции может быть достаточно простых обозначений, возможно, со ссылкой (перекрестной ссылкой) на основную тему. Изложение фактов должно быть чистым и не перегруженным, чтобы пользователь мог легко найти информацию, соответствующую его потребностям. Им может быть неинтересно читать все аспекты продукта.
7. Приспосабливайтесь к различным стилям обучения
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_uCmkZTtLD7r6Elyg2/b2bb8ece-a1f8-5df4-d5ed-f4392f04d374radek_grzybowski_ebrtyyjwpry_unsplash.jpg)
У каждого человека свой стиль обучения. Одни предпочитают глубокие описания, другие - графики и визуальные представления. Однако некоторые пользователи лучше усваивают информацию не при чтении, а при практическом участии.
При создании эффективной и информативной документации по продукту обязательно учитывайте все стили обучения. Например, вставка графических изображений, таких как скриншоты, графики, структурированный текст или ссылки на видео помогает обеспечить понимание документации продукта всеми стилями обучения.
8. Персонализируйте и структурируйте контент при обучении
Персонализируйте продукт [документацию в зависимости от роли аудитории] (https://www.deanhouston.com/news/knowing-audience-document-right-document/). Создавайте различные версии документации в зависимости от ролей целевой аудитории при внедрении контента. Например, вопросы администратора могут не соответствовать вопросам опытного пользователя о документации.
В документации можно привнести уровень персонализации, создав немного разные версии документа, ориентированные больше на роль целевой аудитории. Модификация контента при вводе в эксплуатацию в зависимости от роли аудитории придает документации элемент персонализации.
9. Четко определяйте термины для конкретных аудиторий
В зависимости от целевой аудитории, хорошей практикой является объяснение значения каждого термина, используемого в документации. Вы можете использовать более сложные термины с некоторыми пояснениями, если аудитория является внутренней. Однако, когда к документации обращаются внешние пользователи, нет возможности узнать их опыт.
Четкое определение уникальных или сложных терминов обеспечивает гораздо более эффективную коммуникацию для всех внутренних заинтересованных сторон и внешних пользователей.
10. Обеспечьте метод сбора отзывов пользователей
Обратная связь по документации предоставляет важную информацию об эффективности документа. Предоставьте ссылку или простую кнопку с надписью "Нравится/не нравится" для сбора ценной информации о качестве документации. Благодаря сбору отзывов пользователей документация может быть доработана и улучшена.
11 Избегайте документации с плоской структурой
При создании документации по продукту убедитесь, что она не написана в виде "плоской структуры". Чтение документа, состоящего из плоского текста, трудоемко и может стать утомительным. Кроме того, интерес читателя к документации будет повышенным, если информация имеет отношение к обсуждаемой теме, и читатель сможет быстро ее усвоить.
Разбейте непрерывный плоский текст, выделив выделенную информацию или интегрировав видео, изображения, ссылки и другие методы, чтобы обеспечить лучший UX. Кроме того, предоставляя содержимое документа в виде "кусочков", читатель получит более приятные впечатления и не захочет читать документацию.
12. Создавайте документацию, удобную для SEO
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_JcQwSJ6c9VBPNDxiB/fc593084-5b7f-a9c5-63e1-9b310b83d086nisonco_pr_and_seo_yirdur6hivq_unsplash.jpg)
Лучшая практика создания документации по онлайн-продуктам заключается в том, чтобы убедиться, что она написана в стиле, который документация SEO-friendly. Убедитесь, что документация написана так, чтобы максимально увеличить результаты поиска вашей документации в Интернете. Клиентам может потребоваться поиск документации, и когда у них нет явной ссылки на хостинг-сайт, вводя поисковые запросы, ответы будут более быстрыми и лаконичными, если документация SEO-friendly.
13. Поддерживайте документацию по продукту в актуальном состоянии
Поддержание документации по продукту в актуальном состоянии имеет решающее значение, особенно если доступ к ней осуществляется через Интернет. Часто требования к продукту меняются, и онлайновая документация должна отражать все новые изменения или обновления. Поэтому документация пользователя должна быть актуальной и обновляться с учетом всех последних обновлений, а также обеспечивать уведомление и осведомленность клиента об изменениях в документации продукта.
14. Понять, что пользователи могут не читать документацию по продукту.
Исследование, проведенное в 2014 году, показало, что пользователи не полностью читают всю документацию по продукту (https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false). Основными причинами отказа от чтения документации были:
-
Документация по продукту была слишком сложной
-
Документация не отвечала непосредственно на их вопросы
-
Пользователи не использовали многие функции продукта из-за того, что не читали документацию.
-
Вместо чтения документации многие пользователи предпочитали "практическое" обучение
15. Управление как динамическим, так и статическим контентом
![] (https://cdn.docsie.io/workspace_PfNzfGj3YfKKtTO4T/doc_JLDSpWBDcIaMWR3Ce/file_OgArkokVN075yERo3/b97f1b98-62a4-5b80-5e15-a008439ad625shubham_dhage_hatkch_piqm_unsplash.jpg)
Документация по продукту постоянно развивается благодаря обновлениям, новым функциям, исправленному содержимому, обновленным предупреждениям о техническом обслуживании и другим элементам. Такое обновление считается живым, дышащим документом, который постоянно изменяется в соответствии с требованиями продукта.
Статический контент предоставляет пользователю данные, которые не меняются на протяжении всего срока службы продукта. Идея статического контента заключается в том, чтобы предоставить пользователям, особенно новым пользователям, информацию, которая остается статичной на протяжении всего жизненного цикла продукта. Статический контент жизненно важен для богатой документации, но обычно отходит на второй план по сравнению с динамической документацией.
Поддерживать набор документации проще, когда содержимое [классифицируется как динамическое или статическое] (https://brainly.com/question/24688083). Документация жизненного цикла продукта может быть внедрена и проверена легче, если документация классифицируется как динамическая или статическая. В документации могут быть незначительные изменения для обновления новых функций (статические) или детального обновления продукта (динамические).
16. Лучшие практики для обеспечения доступности документации по продукту
Хотя пользователи могут не читать много документации по продукту, когда она им нужна, они хотят получить ее немедленно. Традиционным способом доставки документации было печатное руководство, которое поставлялось вместе с продуктом. Однако в современном цифровом, онлайновом мире документация часто предоставляется через Интернет.
Независимо от способа доставки документации к продукту, важно иметь легкодоступные точки доступа. Поэтому сегодня преобладающими методами предоставления документации являются:
-
Оффлайн-документация - Многие продукты поставляются в комплекте с печатными руководствами или краткой инструкцией "Быстрый старт". Эти документы обычно являются "одноразовыми" и нелегко распространяются. Однако многие руководства предоставляются в формате PDF, что способствует портативности или возможности распечатать их по требованию.
-
Онлайновая документация- Каждый раз, когда вы ищете ответ на проблему в Google, вы, вероятно, хватаете фрагмент онлайновой документации. Появление Интернета вытеснило печатные руководства или материалы документации по продуктам для конечных пользователей. Некоторые из преимуществ онлайн-документации следующие:
-
Телеработа - пандемия научила нас тому, что работа из дома может быть продуктивнее работы в офисе, особенно когда на наши вопросы отвечает онлайн-документация.
-
Совместная работа - Благодаря легкодоступному порталу онлайн-документации члены команды могут обмениваться информацией на ходу и создавать командную работу, что зачастую невозможно в офисе.
-
Удобство для мобильных устройств - Появление мобильных устройств, таких как iPad и смартфоны, постепенно вытесняет ПК в повседневной работе. Вы можете легко получить доступ к онлайн-документации с помощью смартфона, а любые наболевшие вопросы по продукту можно легко изучить даже в любимом кафе во время обеда.