Посмотрите любимые примеры документации команды Docsie, и как повторить эти примеры в вашем портале знаний.
Документация является неотъемлемой частью процесса разработки продукта. По мере того, как продукт переходит от пробного варианта к реальности, пояснительная документация необходима для обучения клиентов тому, как использовать ваш продукт.
Что в первую очередь необходимо знать покупателю при выборе продукта? Для чего он нужен, что он делает и как это сделать? Давайте воспользуемся примером Docsie!
Docsie - это платформа для документирования продуктов. Она позволяет пользователям создавать, редактировать, аннотировать и публиковать документацию на онлайн-портале знаний. Это так просто - войти в систему, создать новую книгу Docsie и напечатать свой первый материал!
Признаться, мы упростили этот процесс. Однако для документации по продукту сложные функции и особенности требуют более подробных объяснений, чтобы донести концепцию до читателя.
В этой статье мы рассмотрим 10 любимых примеров потрясающей документации по продуктам, созданных командой Docsie. Что еще лучше? Мы также покажем вам, как сделать удивительную документацию по продукту самостоятельно (вдохновляясь нашими удивительными примерами!).
Давайте погрузимся! 🤿
10 удивительных примеров документации по продукту
Ниже вы найдете 10 удивительных примеров документации продукта, отобранных командой Docsie. Мы рассмотрим, как повторить особенности и функции и создать такую же удивительную документацию в Docsie!
1 - Docker
Docker - это платформа виртуализации контейнеров, которая позволяет размещать программное обеспечение в крошечных, модульных и индивидуально изолированных ИТ-средах. Концепция позволяет размещать множество разрозненных сервисов на одной операционной системе хоста путем разделения и совместного использования ресурсов операционной системы между контейнерами.
Docker имеет четко оформленный портал документации по продукту и представляет всю основную информацию, необходимую для загрузки, установки и начала работы с контейнерами Docker. Здесь также представлена документация по продукту на нескольких языках, справочная документация по API и раздел часто задаваемых вопросов (FAQ) в нижней части. Для тех, кто учится визуально, в правом нижнем углу есть также раздел с видео.
Чтобы создать раздел "Начало работы", давайте воспользуемся примером Docsie. Чтобы начать работу в Docsie, необходимо создать учетную запись, подтвердить свой адрес электронной почты, загрузить панель Docsie Workspace, создать новую полку, создать новую книгу - вот и все основы! Создайте структуру заголовков для каждого раздела, напишите инструкции, добавьте картинки и гиперссылки, и в итоге у вас получится структура, похожая на приведенную ниже!
Самое лучшее? Docsie делает это за вас автоматически!
Чтобы узнать, как это делается в Docsie, прочитайте руководство по быстрому запуску Docsie!
2 - Stripe
Stripe - это международная платформа обработки платежей с технической функциональностью, которая позволяет осуществлять пользовательские интеграции и параметры платежей с помощью интерфейса командной строки Stripe (CLI). Миссия компании заключается в увеличении ВВП интернета путем создания виртуальной экономической инфраструктуры, которая упрощает электронную коммерцию.
Эта страница Stripe известна как техническая документация по продукту. На ней рассматривается, как использовать CLI для создания контейнеров Docker (снова привет!) и взаимодействия со Stripe, не используя ничего, кроме команд терминала. На странице вы увидите оглавление, блоки кода с функцией копирования-вставки и внутритекстовые гиперссылки.
В Docsie есть блоки кода, поэтому давайте рассмотрим, как их использовать
Посмотрите этот пример блоков кода в Docsie
Скопируйте этот готовый код, чтобы следовать нашему примеру -
console.log('Hello World');
Откройте книгу Docsie в редакторе Docsie. Приведенный ниже GIF показывает, как найти опцию Code Block на панели инструментов, и содержит пример JavaScript, который печатает "Hello World!".
В вашем Docsie Portal применяется подсветка кода для улучшения ясности для технических читателей. Пользователи могут даже копировать код с помощью удобного значка буфера обмена!
Посмотрите, как применить плагин Code Highlighting в Docsie!
3 - Apple
Вездесущее яблоко! Нет, не съедобное!
Apple предлагает отличную документацию по продуктам для своей популярной линейки смартфонов iPhone. В нашем примере документации по продукции Apple есть выбор версии, оглавление, текст и заголовки, и, наконец, встроенные изображения.
Давайте изучим контроль версий в Docsie!
При чтении документации на портале знаний Docsie читатели могут выбрать версию с помощью плагина выбора версии.
Это позволяет читателям просматривать историческую документацию по продукту - для тех, кто еще не обновился!
Чтобы создать новую версию в Docsie, используйте вкладку управления версиями в Docsie Editor.
Отсюда нажмите Добавить версию + .
Далее выберите номер версии и название версии, прежде чем нажать кнопку Добавить версию. Это так просто! Обновляйте документ новой версии с любыми изменениями функций, и пусть ваши клиенты найдут самую свежую (или запоздалую) информацию!
4 - Разбор
Parse - это отличная программная платформа полного стека, которая предоставляет фреймворки с открытым исходным кодом для бэкендов приложений. Проще говоря, она предлагает готовые ресурсы кода, которым разработчики могут доверять при интеграции в любой проект разработки.
На портале документации Parse есть отличный пример документации в виде таблиц совместимости. Здесь отслеживается совместимость различных архитектур, таких как Node.js и MongoDB, с платформой Parse.
Давайте сделаем это в Docsie!
Мы можем создать четырехколоночную таблицу, подобную примеру Parse, используя блоки таблиц в Docsie.
Выберите значок блока таблицы, затем опцию четырех колонок.
При вводе текста используйте клавишу Enter для перемещения по столбцам. Используйте Ctrl + B на клавиатуре, чтобы сделать текст жирным. Наконец, добавьте эмодзи с помощью опции символов.
Это простой способ написания документации по API и техническому программному обеспечению. Вы можете пойти дальше, добавив гиперссылки на сайт Node.js или внутренние ссылки на соответствующие руководства пользователя. Создайте свою следующую таблицу совместимости API в Docsie!
5 - Flutter
Flutter - это набор инструментов пользовательского интерфейса, созданный компанией Google для обеспечения согласованности дизайна пользовательского интерфейса на мобильных, веб-, настольных и встроенных устройствах. Он способствует быстрому проектированию и разработке пользовательского интерфейса с помощью онлайн-редактора кода, а многоуровневая архитектура на основе контейнеров позволяет полностью настраивать его.
Flutter содержит ряд видеороликов, которые пользователи могут посмотреть и узнать о платформе. Поскольку платформа создана компанией Google, YouTube является логичным выбором для нашего примера!
Вы можете эмулировать этот дизайн в Docsie, используя блоки для вставки видео!
Просто щелкните в своей Книге Docsie, выберите значок вставки видео, а затем скопируйте URL-адрес YouTube в текстовое поле. То же самое можно сделать с Dailymotion, Vimeo и рядом других сайтов видеохостинга.
У нас есть GIF, показывающий этот процесс, чтобы вы могли добавлять свои собственные видео в Docsie - попробуйте!
Узнайте, как использовать панель инструментов редактора Docsie.
6 - Ionic Framework
Ionic Framework - это набор инструментов пользовательского интерфейса с открытым исходным кодом для создания производительных настольных и мобильных приложений с использованием HTML, CSS, JavaScript и других веб-технологий.
Он интегрируется с популярными фреймворками, такими как Angular, React и Vue, с различными компонентами пользовательского интерфейса, функциями родных устройств и поддержкой тем.
У Ionic есть отличный пример мобильного телефона, встроенный в сайт. Давайте добавим аналогичный пример в нашу Docsie Book, используя вставки iFrame!
Сначала скопируйте код ниже:
<iframe loading="lazy" importance="low" src="https://ionic-docs-demo.herokuapp.com/?ionic:mode=ios"></iframe>.
Затем нажмите на блок вставки кода в редакторе Docsie Editor. Вставьте сюда код вставки iFrame, затем нажмите кнопку Сохранить, чтобы продолжить. Ниже приведен GIF, иллюстрирующий этот процесс.
Смотрите наш официальный список интеграций, использующих iFrame в Docsie!
7 - DigitalOcean
DigitalOcean - это платформа облачных вычислительных услуг, позволяющая клиентам размещать серверы, виртуальные машины, базы данных и многое другое. Она предлагает выделенные услуги Kubernetes для масштабируемых контейнерных приложений, а также управляемые решения для веб-хостинга, мобильных приложений, озер больших данных и услуг VPN.
DigitalOcean предлагает функцию обратной связи в своих документах для сбора отзывов пользователей и итерации контента. Давайте рассмотрим, как это сделать в Docsie!
Vocally - это эквивалентная функция для сбора отзывов в Docsie. Она позволяет пользователям оставлять звездную оценку, текстовый отзыв и даже видеозапись - здорово!
Здесь вы можете получить доступ ко всем отзывам, оставленным в Docsie Vocally. Пользователи могут поставить оценку от 1 до 5 звезд и дать краткое текстовое пояснение. Некоторые пользователи могут оставить запись экрана, что поможет вам точно определить проблему!
Каждый клиент Docsie получает доступ к Vocally, и он неоценим в выявлении сильных и слабых сторон вашей документации. Вы не всегда можете сделать все правильно с первого раза, но вы можете сделать это правильнее в следующей итерации, когда ваши авторы используют Docsie Vocally!
8 - Slack
Slack, пожалуй, стал Whatsapp в деловом мире. Популярная платформа мгновенного обмена сообщениями (IM) для бизнеса предлагает голосовые и видеозвонки, обмен изображениями и GIF, деревья ответов на комментарии и многое другое для организации и упрощения деловых коммуникаций.
Slack предлагает всплывающие подсказки на портале документации для выделения важной информации и вызова соответствующих функций. Давайте повторим это в Docsie!
Мы можем сделать всплывающую подсказку, как описано выше, используя блоки цитат в Docsie.
Узнайте, как использовать различные кнопки редактора Docsie.
Просто перейдите на панель инструментов редактора Docsie и выберите значок блока цитат. Здесь вы можете выбрать тип блока: информационный, предупреждающий или вопросительный. Мы иллюстрируем это в анимированном GIF ниже.
![Как добавить блоки вызова или цитаты в Docsie Books с помощью панели инструментов Docsie Editor] (https://docsie-app-media.s3.amazonaws.com/image/7093/doc_GzKTESk1IUWjA77hg/cientdcamlnfozadvsgw "Как добавить блоки вызова или цитаты в Docsie Books с помощью панели инструментов Docsie Editor")
Вот несколько вариантов использования информационных, предупреждающих и вопросительных блоков в живом Docsie Portal. Вы можете дополнительно использовать блоки вопросов и предупреждений для создания утверждений типа "вопрос-ответ" - проявите свою креативность, используя блоки цитат в своей следующей книге Docsie!
![Живой пример всех трех типов блоков вызова или цитат в Docsie Portal] (https://docsie-app-media.s3.amazonaws.com/image/7093/doc_GzKTESk1IUWjA77hg/wrztunbzpesljcwarenw "Живой пример всех трех типов блоков вызова или цитат в Docsie Portal")
9 - Rust
Rust - это язык программирования, разработанный с учетом скорости. Он может предотвращать сегфаулты и гарантирует безопасность потоков процессора. Rust можно использовать для создания REST-API-фреймворков, взаимодействия с базами данных, такими как PostgreSQL, и многого другого.
Библиотека Rust Standard содержит встроенные фрагменты кода, которые упрощают просмотр документации API. Давайте совместим это в Docsie!
Фрагменты встроенного кода включают Vec<T> и Option<T> . Мы можем сделать это в Docsie с помощью кнопки разметки.
Чтобы разметить текст как код, просто нажмите и перетащите, чтобы выделить текст, а затем нажмите кнопку разметки. Ниже приведен GIF, иллюстрирующий этот процесс.
Текст разметки также содержит гиперссылки. Эта ссылка должна перенаправлять на глоссарий терминов, объясняющий, что делает фрагмент кода.
10 - Yoast
Yoast - это платформа для поисковой оптимизации (SEO), разработанная для того, чтобы помочь бизнесу оптимизировать свои WordPress сайты и улучшить знания о лучших практиках SEO. Плагин Yoast SEO оптимизирует веб-сайты для улучшения показателей на страницах результатов поисковой системы Google (SERPS) для привлечения клиентов.
Yoast предлагает пошаговые руководства по использованию заголовков списков на своем портале документации. Мы можем повторить это с помощью заголовков списков в Docsie!
Чтобы сделать это в Docsie, сначала создайте книгу и откройте редактор Docsie.
Затем щелкните в текстовом поле и выберите опцию заголовка списка на панели инструментов редактора Docsie. Ниже приведен GIF, иллюстрирующий этот процесс.
Заголовки списков являются частью спецификации HTML. В Docsie заголовки списков очень полезны, поскольку они позволяют создавать прямые ссылки в документации. Это означает, что когда пользователи нажимают на ссылку, они попадают прямо в заголовок списка (вместо того, чтобы прокручивать или листать!).
![Как добавить блоки для вставки видео в Docsie Books с помощью панели инструментов Docsie Editor] (https://docsie-app-media.s3.amazonaws.com/image/7093/doc_GzKTESk1IUWjA77hg/lradwltxuqolxfmzxxwr "Как добавить блоки для вставки видео в Docsie Books с помощью панели инструментов Docsie Editor")
Используйте эти возможности Docsie с пользой для себя! 🏆
Эти 10 примеров документации показывают, насколько полезными могут быть руководства пользователя. В следующий раз, когда вы будете создавать руководство пользователя, используйте эти советы и рекомендации Docsie с пользой для себя! Наши примеры великолепны, но мы знаем, что ваши будут еще лучше! 📐👌
Docsie - это платформа сквозного управления документацией, которую компании используют для создания веб-частотных вопросов, документации по продуктам, руководств пользователя, справочных документов и руководств пользователя. Платформа предлагает ориентированное на клиента сотрудничество, широкие возможности встраивания, адаптированные переводы и мощную публикацию под рукой.
Start onboarding сегодня, и создавайте восхитительную цифровую документацию с Docsie!