12 лучших примеров документации

Могут ли ваши клиенты самостоятельно найти решение своих проблем с вашими продуктами или услугами? И умеют ли они делать это быстро и легко?

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

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

Типы документации

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

Документация пользователя

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

Документация для разработчиков

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

Техническая документация

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

Документация проекта

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

Преимущества документации

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

Знания в одном месте

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

Повышение производительности

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

Повышение удовлетворенности

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

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

Плагин героической базы знаний

Создайте базу знаний и помогите своим клиентам помочь себе.

Получить плагин

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

Google

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

Другие примечательные особенности документации Google включают:

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

Скайп

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

Другие вещи, которые следует отметить, включают:

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

Apple iPhone

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

Примечательные аспекты документации iPhone включают:

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

Примеры документации для разработчиков

Документы Докера

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

Другими факторами, которые делают эту документацию отличной, являются:

• В конце различных глав есть разделы Recap и Cheat Sheet. Эти разделы помогают закрепить понятия, которые пользователь мог пропустить.
• Внутренние ссылки размещены на всех страницах документации, чтобы пользователю было легко расширить часть информации.
• Это позволяет вернуться к необходимой странице или главе, которая необходима для понимания информации, представленной на текущей странице.

Центр разработки Heroku

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

Вот еще несколько вещей, которые стоит отметить в документации Heroku.

• Он дает последовательные шаги для разных языков программирования вместе с соответствующими пакетами.
• Доступны ресурсы о других инструментах и ​​интеграциях, которые часто используются вместе с Heroku, например, об использовании Github в качестве репозитория кода.

Документы Twilio

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

Что еще делает эту документацию замечательной? Следующее:

• Документация для разработчиков Twilio отличается элегантным стилем шрифта и контрастными гиперссылками. Весь интерфейс очень удобен для глаз.
• Есть несколько фрагментов исходного кода, которые разработчики могут сразу же скопировать и вставить, чтобы сэкономить время и нервы.
• Twilio обеспечивает удивительный уровень глубины даже для начинающих, с такими темами, как «Что вообще такое REST API?»

Примеры технической документации

Монитор кампании

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

Что еще делает его хорошей документацией?

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

Канва

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

Документация Canva работает, потому что:

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

Дропбокс

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

Дополнительные сведения о документации Dropbox включают:

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

Примеры проектной документации

Устав проекта Университета Гвельфа

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

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

Шаблон плана проекта для MS Word

Еще одним примером проектной документации является простой шаблон плана проекта для MS Word. Он позволяет добавлять задачи, отслеживать даты начала и окончания, а также следить за статусом каждой задачи.

Отчет о состоянии проекта

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

Добавление документации на ваш сайт

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

Если вы готовы приступить к работе, подумайте о том, чтобы Heroic KB добавил документацию на ваш веб-сайт. Это простой в использовании плагин базы знаний, который интегрирует красивую документацию с вашим сайтом WordPress. Основные особенности Heroic KB включают в себя:

Мгновенная интеграция с темами. База знаний Heroic, основанная на шаблонах, позволяет вам контролировать внешний вид вашей документации. Вам также предоставляются примечания по интеграции темы, что делает Heroic KB одним из самых гибких плагинов базы знаний для WordPress.

Мгновенные ответы : Молниеносный поиск AJAX позволяет клиентам находить то, что им нужно, за считанные секунды.

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

Простая организация : Heroic KB поставляется с функцией перетаскивания категорий, поэтому вы можете заказать все, что вам нужно.

Контроль доступа пользователей : защита паролем и скрытие статей от разных ролей пользователей.

Поддержка файловых вложений : предоставьте своим посетителям загружаемые файлы в ваших статьях.

Поддержка виджетов : есть три виджета для отображения статей базы знаний, категорий и авторов на вашем сайте.

Удобство для разработчиков : Heroic KB «из коробки» работает с большинством хорошо закодированных тем, а также с адаптивным стилем по умолчанию.

Языковая поддержка : плагин готов к переводу, совместим с WPML и предлагает полную поддержку локализации.

Отличное обслуживание клиентов : команда Heroic KB всегда готова и быстро помочь, если у вас возникнут какие-либо проблемы.

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

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

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