![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_fnrc6e2hqBPbGE5DG/boo_NbQ7i8LYu6f7q4rnn/13a8cb93-d20f-41ad-1e5e-6e888f610ea7corinne_kutz_tMI2__r5Nfo_unsplash.jpg)
Многие технологические SaaS-компании испытывают трудности с процессом разработки и распространения документации по продукту (руководства пользователя, руководства пользователя и/или учебники) среди своих потребителей.
Часто это происходит из-за отсутствия знаний или процессов, связанных с правильной обработкой и созданием руководств, или даже с тем, кто несет за них ответственность.
Пока в этом мире существует потребность в инструментах и программном обеспечении, мы будем нуждаться в эффективной коммуникации, чтобы эффективно донести до других информацию об использовании, разработке, функционировании и архитектуре этих товаров. Если вы задаетесь вопросом, почему так происходит, ответ прост. Это связано с тем, что навыки технической коммуникации играют решающую роль в сборе информации и позволяют аудитории более эффективно понять продукт или технологию.
В то время как в реальном мире общение осуществляется с помощью речи, языка тела и выражения эмоций, в виртуальном мире техническое общение происходит посредством технической документации на продукцию!
Единственная цель технической документации - облегчить пользователю понимание динамики работы и архитектуры продукта и технологии. Это больше похоже на руководство "как пользоваться" для новых сотрудников, пользователей/клиентов и всех остальных, кто должен знать методы работы, подробное описание гаек и болтов продукта!
Менеджер по продукту обязан взять на себя ответственность за развитие команды по созданию, управлению, публикации и поддержке документации по продукту.
Я уверен, что каждый менеджер по продукции говорил или слышал в своем отделе следующее: "Документирование продукта - это компонент обязанностей владельца продукта"; "Каждая команда разработчиков должна документировать свои приложения"; "Функция была развернута, было ли обновлено руководство?" или, что гораздо хуже, "в технической документации есть ошибка".
Очевидно, что техническая документация на продукт может вызывать недоумение, какой бы простой она ни казалась! Пока люди пытаются решить или спорят по поводу строк в предыдущем абзаце, руководства и учебники ухудшаются, что наносит ущерб имиджу вашего "продукта/компании".
Чтобы помочь всем, кто сталкивается с подобными проблемами, вот некоторые процедуры, которые необходимо выполнить для оптимизации документации по вашей продукции.
Какова цель документации по продукту?
Когда вы говорите о документации на продукт для технологического продукта или услуги, вы имеете в виду информацию, которая описывает его, и данные, относящиеся к нему.
Техническая документация, или документация на продукт, - это помощь вашей аудитории и клиентам в использовании, чтении, понимании и применении вашего продукта. Большинство документации на продукцию, конечно же, создается в различных областях, включая инженерное дело, медицину, информационные технологии и маркетинг.
Отличная техническая документация на продукт помогает вашей аудитории ориентироваться в вашем продукте и позволяет им использовать его без осложнений.
Еще одно соображение заключается в том, что техническая документация имеет решающее значение для помощи клиентам и вносит значительный вклад в брендинг и доверие к вашей компании. Когда они больше всего нуждаются в помощи, пользователи ищут техническую документацию. Аудитория использует ваш продукт для изучения процессов и решения проблем.
Это означает, что наличие тщательной и полной документации по продукту, которая динамично развивается благодаря возможностям поиска, очень важно.
Чем отличается документация на продукцию
В этом разделе вы можете посмотреть, какая документация на продукцию нужна вашим клиентам или заказчикам.
Существует множество различных типов документации по продукту, которые отвечают потребностям различных типов случаев использования и потребностей пользователей:
Документация пользователя продукта: Она состоит из руководств пользователя, руководств по использованию, учебников, часто задаваемых вопросов, заметок о выпуске и учебных руководств, а также операционных процедур.
Корпоративная документация: [Опросы показывают] (https://www.inc.com/david-finkel/why-policies-and-procedures-manuals-are-dead-and-what-you-should-replace-them-wi.html), что более 8 из 10 компаний из 1000 опрошенных используют формальные политики и руководства по процедурам.
Существует множество другой корпоративной документации, которая включает в себя документацию, относящуюся к политике и процедурам компании, как указано в исследовании выше, инструктивные руководства, технические практики, поведенческую и этическую документацию. А также юридическая документация, которая может быть защищена паролем. Кроме того, структуры компаний, лучшие практики и процедуры, а также руководства по техническому обслуживанию.
Документация разработчика: этот тип документации предоставляет инструкции по разработке программного продукта, функциональные спецификации, технические спецификации, документацию и инструменты для помощи в рабочем процессе разработчика.
Теперь, когда мы лучше понимаем различные типы технической документации и документации по продуктам, давайте обсудим, с чего начинаются первые шаги надежного процесса разработки документации по управлению продуктами.
Найти руководителя отдела разработки документации по продукции
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_PsI4RmXQikpEACQlf/boo_NbQ7i8LYu6f7q4rnn/eccf743b-f84f-655a-e8cb-52655df7bc4ccampaign_creators_gMsnXqILjp4_unsplash.jpg)
Очень типичная проблема - определить, кто должен отвечать за документацию продукта, не как человек, который просто обновляет ее, а как человек, который несет ответственность за качество и успех продукта.
Хотя некоторые компании считают, что каждый владелец продукта и/или менеджер продукта отвечает за документацию продукта, на другие отделы, такие как отдел разработки и отдел поддержки, также может быть возложена ответственность за поддержание актуальности и эффективности руководств пользователя, руководств пользователя и всех аспектов документации продукта.
Разработка документации по продукту имеет множество движущихся частей, но здесь мы остановимся на двух из них:
-
Кто понимает принцип работы продукта на всех уровнях (сюда входят команды разработчиков продукта и спецификаций).
-
Те, кто получает информацию от клиентов, которые изучают документацию по продукту и выслушивают их трудности, отзывы и опасения по поводу понимания документации по продукту.
Первая часть помогает нам создать документацию по продукту с учетом имеющихся знаний, и она отправляется заказчику, который в свою очередь дает обратную связь и инициирует второй процесс, который помогает оптимизировать документацию.
Иногда эти два момента не совсем совпадают, что приводит к ситуациям, в которых документация на продукт никогда не получает необходимого внимания.
Один из подходов заключается в том, чтобы назначить человека, который будет отвечать за "производительность" документации по продукции, руководств по продукции и руководств пользователя. Рассмотрим заказ на поставку, в котором в качестве товара указана "Документация на продукцию". Он отвечает за то, чтобы пройтись по всем командам компании, набросать, как каждый Продукт создает свои руководства, и определить проблемы, связанные с этим процессом.
Намерение заключается не в том, чтобы этот владелец продукта и менеджер продукта полностью отвечали за создание и изменение руководств, а в том, чтобы помочь отдельным людям в каждой команде в управлении документами.
Этот человек должен изучить, как пользователи взаимодействуют с документами, предложить способы сделать обновления более оперативными и собрать обратную связь, чтобы определить, как улучшить документацию и объяснения каждого продукта с учетом его целевой аудитории.
Наличие человека, отвечающего за все аспекты документации по продукту, управление рабочим процессом и различными отделами, которые должны заполнять эту документацию, повысит производительность в компании, повысит осведомленность и обучение клиентов с помощью порталов знаний о продукте и в целом упростит понимание продукта.
Смотрите на документацию по продукту как на сам продукт.
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_JdDBUtqTll6qYQgc9/boo_NbQ7i8LYu6f7q4rnn/cd6029ed-9933-9a5f-4007-c4d28888fa5ebram_naus_n8Qb1ZAkK88_unsplash.jpg)
Продукты существуют для того, чтобы предоставлять определенную ценность, которая соответствует ожиданиям клиента или превосходит их. Согласно статистике, сгенерированной D2WorldWide 73,7% людей считают документацию более полезной, чем видео, упаковка или продавцы, когда они ищут информацию о продуктах, которые они собираются приобрести.
Рассмотрите факторы, которые способствуют привлекательности продукта. Существует несколько факторов, которые могут повлиять на привлекательность продукта, но в рамках данной статьи мы остановимся на трех. Они превосходят ожидания с точки зрения стоимости; их использование приносит удовлетворение; и они конкурентоспособны.
Кроме того, те же понятия применимы к хорошей документации по продукту в Интернете. Документация на продукт, которая "превосходит ожидаемую ценность", иллюстрирует не только то, как использовать указанный предмет, но и предлагает решения, о которых клиент не знает или считает их невозможными. Всегда необходимо смотреть, как другие компании оформляют документацию на продукцию, чтобы учиться на их успехах и ошибках.
Бессмысленно иметь компанию, которая разрабатывает уникальное и высококачественное программное обеспечение, опережающее конкурентов, если разработчики и клиенты, которые внедряют ваши технические документы по продуктам, не могут их понять.
Учтите, что человек, читающий документацию по продукту, может быть незнаком со спектром возможных решений, предлагаемых продуктом, или с рынком (как это обычно бывает с техническими продуктами SaaS), поэтому его необходимо "просветить" относительно этих решений и различных вариантов, связанных с продуктом.
Документы продукта, "удобство использования которых порождает удовлетворение", следуют логической схеме чтения, подходящей для их целевой аудитории. Бесполезно иметь самое подробное руководство в мире, если оно представляет собой PDF-файл на 500 страниц, не содержит примера кода и не является динамически созданным с возможностью поиска и другими функциями. Соберите отзывы пользователей вашего продукта и сотрудников службы поддержки. Они выяснят основные области напряжения, связанные с представленными данными.
Конкурентоспособная документация на продукцию - это документация, которая постоянно обновляется с использованием наиболее эффективных методов обмена информацией. Они обладают такими замечательными функциями, как встроенные возможности поиска, переводы, различные версии, встроенные изображения, видео и многое другое!
Даже если ваше руководство по интеграции написано лучше всех в технологическом бизнесе, оно будет лишено привлекательности без встроенного видео, изображений и кодов, которые можно копировать и вставлять для простоты использования вашими технически подкованными клиентами, приобретающими ваши технические SaaS-продукты.
Всегда необходимо видеть, как другие фирмы инициируют свои статьи, чтобы учиться на их успехах и ошибках.
Бессмысленно иметь компанию, которая разрабатывает уникальное и высококачественное программное обеспечение, опережающее конкурентов, если разработчики и клиенты, которые интегрируют ваши документы, не могут понять их во всей их полноте.
Отзывы о документации по продуктам
Эффективная техническая документация продукта улучшает опыт конечного пользователя, оттачивая процесс понимания продуктов и диагностируя любые проблемы с помощью легкодоступных письменных решений. Когда клиенты доверяют и понимают, как использовать вашу продукцию, они могут вернуться к вам в будущем, когда возникнет необходимость.
Новое исследование, проведенное компанией SDL, показывает, что роль документации на мировых рынках возрастает. Исследование показывает, что около 53% покупателей совершают покупки с помощью технической литературы еще до того, как попробуют продукт. Кроме того, еще одна собранная статистика из этого исследования показывает, что 94% покупателей считают, что наличие информации о продукте в одном месте является полезным и нужным. В связи с этим в наши дни каждая компания уделяет одинаковое внимание как документации о продукте, так и разработке или тестированию продукта.
Даже если у документации есть назначенный владелец, который управляет командой разработчиков документации, они создали документацию по продукции, которая была пересмотрена и оценена для улучшения удобства использования, и была должным образом обновлена, вы продолжаете бороться за то, чтобы ваши пользователи и покупатели понимали ваши технические продукты. Это может возникнуть в результате того, что пользователи/читатели не могут понять, как читаются ваши документы или какие вопросы они задают. Поэтому одним из самых сложных аспектов составления документов является постановка себя на место читателя. В конце концов, тот, кто составляет документацию по продукту, должен хорошо разбираться в нем.
Этот опыт может привести к тому, что автор упустит из виду вещи, не столь очевидные для рядового пользователя. Обычно это происходит, когда то, что очевидно для людей, создающих продукт, не совсем понятно тем, кто его покупает и использует.
Это может произойти разными способами:
Структура или форма написания: Хотя это может показаться субъективным словом, даже манера написания справочника может создать путаницу. Очень важно определить тип читателя, который читает документацию; в противном случае могут возникнуть такие высказывания, как "Разработчики предпочитают примеры описательному тексту" или "Наша документация непонятна, несмотря на наличие примеров и визуальных эффектов".
Тема, организованная в руководствах: Иногда компании, работающие на одном рынке, разрабатывают стандартизированный формат документации. Если руководства вашей компании не придерживаются его, у читателя может возникнуть ощущение странности.
Чрезмерное использование неявных терминов: В справочнике сокращения могут иметь мало смысла, даже если эти фразы не являются акронимами. Это трудно воспринимается, но некоторые слова, такие как "статус", "id", "полномочия", содержат неявный смысл, замаскированный под явный. Используйте конкретные обозначения, например, "UserID", а не "UID".
Верный перевод: перевод - это огромная часть глобального охвата. Очень часто компании создают плохо переведенные руководства пользователя и документацию на продукцию, которые не соответствуют культуре определенных стран или просто слова переводятся не так, как они переводились бы на английский язык в данной стране. Понимание этих тонких нюансов может проделать долгий путь от нечитабельной информации до полностью переведенной документации на продукт.
Чтобы избежать подобных ситуаций, необходимо разработать решение, которое собирает и анализирует отзывы пользователей и модели навигации.
Инструменты обратной связи, такие как функция Vocally a Docsie, - это отличный способ получить и оценить шаблоны навигации и изучить, как ваши клиенты просматривают документацию по продукту. [Узнайте 7 золотых правил сбора отзывов здесь] (https://www.docsie.io/blog/articles/7-golden-rules-to-successfully-approach-customer-feedback/).
Эта информация очень важна для обновления и оптимизации ваших руководств пользователя, руководств пользователя и документации по продуктам, чтобы создать для ваших клиентов более удобный опыт ознакомления с вашими продуктами. Ничто так не расстраивает, как внедрение нового продукта и увеличение количества запросов в службу поддержки из-за некачественных инструкций.
Как написать исчерпывающую документацию по продукту
Качественная документация по продукту является увлекательной, полезной и мощной. Я бы утверждал, что умелое составление документации - это необходимый компонент хорошего управления продуктом. Как бы ни была велика роль менеджеров по продуктам в разработке продуктов, значительной частью успеха является создание потрясающей отполированной документации по продуктам, которую наши клиенты могут понять и использовать для расширения своих знаний о наших продуктах.
Что происходит с большинством документации по продуктам?
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_6UrbmSp116NpfVK1l/boo_NbQ7i8LYu6f7q4rnn/64a68ac0-4ef1-308c-ad6b-5ce4525f5301jeshoots_com__2vD8lIhdnw_unsplash.jpg)
Многие менеджеры по продуктам не любят составлять документацию по продуктам. Документация по продуктам, с которой они знакомы, может не найти отклика у клиентов, если не уделить больше внимания тому, чтобы сделать ее привлекательной, легкой для чтения и восприятия.
Однако часто компании не уделяют должного внимания созданию и оформлению замечательной документации по продуктам. Плохая документация по продукции пишется с единственной целью - быть написанной. В ней используются пространные фразы, наполненные неопределенно приемлемыми мыслями, и плохое оформление, чтобы отбить у зрителей желание взаимодействовать с материалом. Некачественная документация по продукту создается для того, чтобы оградить автора от критики, и является пустой тратой времени. По этой же причине ее не любят читать и клиенты.
Как исправить ситуацию и написать лучшую документацию по продукту, которую наши клиенты будут читать с удовольствием?
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_NSTKBpS5BKDoj224Y/boo_NbQ7i8LYu6f7q4rnn/d83ce28b-38c3-bb53-8a14-2e1212d0fc5cscott_graham_5fNmWej4tAA_unsplash.jpg)
Отличная документация по продукту пишется с намерением, чтобы ее читали. Она лаконична. Хорошая документация по продукту хорошо отформатирована и может быть прочитана и понята всеми сотрудниками компании или клиентами за три минуты. Она избегает жаргона и либо дает, либо ссылается на точку зрения на уровне бизнеса. Отличная документация по продукту уделяет время описанию конкретных примеров использования, которые клиенты могут понять и применить для расширенного использования продукта. Она увлекает читателя и привлекает внимание к основным проблемам с хорошо продуманными решениями.
Потенциал хорошо написанной документации по продукту
В малом, среднем или крупном бизнесе хорошо оформленная техническая документация на продукт может сэкономить много времени и помочь сотрудникам работать более продуктивно. Это, как правило, справедливо для большинства компаний, основанных на производстве продукции, которые тратят значительную часть своего бюджета на наем технических писателей и написание технической документации на продукцию.
Если в вашем бизнесе для создания документации по продуктам работает более двух человек, то создание культуры хорошей документации полностью оправдано. Существует множество причин, по которым вы хотите, чтобы ваша команда создавала, управляла и публиковала хорошо составленную документацию по продуктам, но в следующем разделе мы рассмотрим, как эффективная документация по продуктам является недорогим подходом к улучшению обслуживания клиентов.
Эффективная документация по продукту - это низкозатратный подход к улучшению клиентского опыта
Надежный клиентский опыт является главным условием сохранения и поддержания лояльных клиентов. Большинство руководителей проектов являются оптимистами - они получают концепцию, воодушевляются, а затем выполняют ее. Хотя энтузиазм достоин восхищения, а исполнение кажется продуктивным, наличие плана игры перед выполнением надлежащей документации по продукту является жизненно важным.
Первые шаги после мозгового штурма игрового плана - это начало цикла проектирования и структурирование содержания документации по продукту таким образом, чтобы ее было постепенно легко читать клиентам.
Кроме того, получение отзывов от клиентов о текущей документации является жизненно важным шагом, необходимым для реструктуризации документации в соответствии с потребностями клиентов. Таким образом, менеджеры проектов могут создавать, управлять, поддерживать, публиковать и оптимизировать свою документацию с помощью восприятия и автоматизации. Это не простая и незначительная задача, и наличие таких замечательных инструментов, как Docsie , которые автоматизируют многие процессы для создания эффективной документации по продукту, очень важно для успеха.
Привлекательная, увлекательная и удобная для навигации техническая документация помогает потребителям изучить продукт за меньшее время, что повышает вероятность того, что они правильно настроят продукт и будут правильно его использовать.
Все эти стратегии создания хорошо отшлифованной документации по продукту приведут к повышению рейтинга продукта, более благоприятным отзывам и увеличению продаж - все они связаны друг с другом; поэтому само собой разумеется, что в результате увеличиваются продажи.
Как создать хорошо составленную документацию на продукт
Как создавать эффективную документацию и формировать культуру, в которой она является стандартом? Написание эффективной документации - сложная задача, но в Docsie есть много хороших функций, которые могут помочь запустить этот процесс создания хорошо продуманных и динамичных порталов документации по продуктам. Ниже приводится краткое описание того, как мы подходим к этому вопросу.
Теперь приступим:
Ограничения страниц обеспечивают читабельность. Написание приличного документа не должно быть трудным для чтения и умственной обработки. Затянутые, блуждающие фразы часто свидетельствуют о недостатке ясности. Если сообщение не может быть правильно изложено на одной странице, это признак того, что менеджеру продукта, вероятно, следует вернуться назад и более подробно изложить ситуацию.
Форматирование улучшает качество. Плохо структурированная документация по продукту увеличивает вероятность того, что автор будет ее переиначивать. Создайте шаблон с хорошо отформатированными разделами, таблицами и заголовками документа. Это одноразовая инвестиция с высоким дивидендным потенциалом.
Шаблоны помогут вам сэкономить время. Гораздо проще удалить раздел из шаблона, чем вспоминать, как его добавить. Это не покровительственное отношение; скорее, это эффективно и экономит время. Простые разделы, напоминающие писателю о необходимости начать с общего фона и конкретизировать измерения или опасные предположения, позволяют более точно написать текст и выстроить иерархию решений.
Комментируйте и назначайте задания Нет более верного способа демотивировать сотрудников на создание высококачественной документации, чем отсутствие замечаний. Комментарии не обязательно должны быть очень умными; скорее, они должны показывать вовлеченность и служить образцом. Хотя идеальным вариантом является предоставление отзывов в цифровом виде, чтобы другие сотрудники компании могли извлечь пользу из беседы асинхронно, простая функция в Docsie, позволяющая комментировать и сотрудничать с вашей командой, отлично работает с документацией продукта!
Посмотрите этот блог, чтобы узнать больше о том, как Docsie помогает в совместной работе над документацией продукта
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
Типы документов должны быть масштабируемыми, чтобы соответствовать требованиям вашей компании. Поскольку в процесс разработки продукта вовлекается все больше заинтересованных сторон, общение должно быть разделено на несколько документов (особенно если необходимо соблюсти критерий "краткости" в одну страницу). Docsie позволяет создать полезное и устойчивое решение для растущих команд по документированию продукции.
Используйте Docsie как способ ускорить создание потрясающей документации по продукту
Docsie - это очень удобная платформа, которая поможет вам в каждом аспекте создания документации по продукту и портала знаний. Она имеет множество встроенных функций, которые делают создание, публикацию, поддержку и управление проектами по созданию документации по продукту очень простым и увлекательным! Вот лишь некоторые из многих функций Docsie, которые помогут вам достичь этих целей:
Возможность редактирования: Docsie позволяет всем нашим пользователям редактировать документацию продукта после публикации, создавая альтернативную версию, которая не будет запущена, пока она не станет активной. Это замечательно, потому что команды управления продуктом могут работать над редактированием и изменением документации продукта, а затем сделать ее активной, как только они будут готовы к этому, не прыгая через HTML и CSS обручи. Документация по продукту будет автоматически отображаться по нажатию кнопки, когда она будет готова.
Возможность поиска: Если документация вашего продукта многочисленна или в ней много функций, плагин поиска Docsies является полезным бонусом, который позволяет вашим клиентам быстро и легко искать в вашей документации необходимую информацию, чтобы ускорить процесс, в котором они просматривают и усваивают информацию из документации вашего продукта.
Возможность размещения ссылок: Docsie делает вашу документацию по продуктам SEO дружественной. Вы можете сделать обратную ссылку на определенные страницы сайта вашей компании или просто написать ключевые слова, основанные на вашей продукции, которые будут доступны для поиска в Интернете и привлекут новых клиентов, желающих найти тот же продукт, что и у вас.
Возможность различных переводов: Современный переводчик Docsies позволяет нашим пользователям переводить документацию по продуктам на различные языки. Кроме того, с помощью функции выбора языка Docsie ваши клиенты могут выбирать, какой язык им больше подходит. Это очень полезно для глобального охвата и расширения клиентской базы компании, а также для укрепления доверия со своими новыми клиентами и заказчиками за рубежом.
Возможность назначать задания и комментировать для беспрепятственного сотрудничества: Docsie имеет потрясающие инструменты для совместной работы с командой разработчиков документации по продукту. Вы можете назначать комментарии, ставить задачи и распределять роли, чтобы лучше контролировать, какие задачи выполняются тем или иным пользователем, работающим над проектом документации продукта с помощью Docsie. [Чтобы узнать больше, посетите этот блог здесь] (https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/).
Генерация обратной связи: Возможность знать, что ваши клиенты думают о вашей документации, - это единственный способ узнать, как оптимизировать документацию продукта в соответствии с потребностями клиентов, чтобы они могли с большим удовольствием изучать документацию продукта и порталы знаний Чтобы узнать больше о важности обратной связи с документацией продукта, загляните в мой блог здесь.
Существует также множество других функций и возможностей, которые Docsie позволяет вам и вашей команде управления продуктом использовать для создания потрясающей документации по продукту. В этой статье я хотел бы перейти к плагинам, которые каждый портал знаний Docsie и документация продукта могут добавить к своим документам, чтобы улучшить их и повысить удобство использования.
Плагины Docsie, чтобы сделать ваш портал документации динамичным! Docsie имеет множество плагинов, которые вы можете использовать, чтобы сделать вашу документацию более привлекательной. В этом блоге я разделю их на 3 части.
В этом разделе мы разделим объяснение этих плагинов для портала знаний на три части.
ЧАСТЬ 1: В первой части мы покажем, что такое "Display Version Picker", "Display Language Picker", "Display Section Anchors" и "Display Footer Navigation".
ЧАСТЬ 2: В этой части мы покажем плагин 'Выделение кода', 'Поиск' и 'Поделиться в социальной сети'.
ЧАСТЬ 3: В третьей части мы покажем плагин 'Предварительный просмотр изображений', 'Метаданные документа' и 'Автоподсветка раздела'.
Прежде чем мы перейдем к плагинам, давайте поговорим о том, как получить доступ к этим плагинам в платформе Docsie.
Во-первых, в рабочей области нам нужно нажать на три точки в правом верхнем углу и открыть наш аккаунт:
Затем в Deployments мы можем получить доступ к плагинам после создания нового развертывания через 'Configure a new deployment+'.
Затем нажмите 'More options', что позволит вам добавить эти плагины в вашу развернутую документацию через ваш встроенный скрипт или через портал Docsie.
Другой вариант - получить доступ к плагинам порталов знаний Docsie через кнопку "Обновить конфигурацию развертывания" под уже опубликованной документацией.
Откроется эта панель, и вы сможете добавлять или убирать плагины по своему усмотрению, а затем обновить развертывание.
ЧАСТЬ 1:
Теперь, когда мы знаем, как получить доступ к Docsie Pluggin, давайте перейдем к ЧАСТЬ 1.
Чтобы посмотреть часть 1 видеоучебника, пожалуйста, посмотрите это видео здесь:
.
Давайте начнем с "Выбор версии дисплея" и "Выбор языка дисплея".
Как только эти два параметра станут активными, они появятся в левой нижней части вашего портала знаний в виде плавающих вкладок. Они позволяют вашим клиентам и тем, кто читает документацию по вашему продукту, просматривать документацию на разных языках и в разных версиях.
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_15B6AEHxast4mhcXQ/boo_NbQ7i8LYu6f7q4rnn/3dc1ff60-4be8-3457-f12c-be1f2bbff93aimage.png)
Как только пользователь нажмет кнопку "Язык" в окне выбора языка, вся документация, которую он читает, будет переведена на этот язык.
Активированный якорь Display Section позволяет вашему клиенту иметь ссылки рядом с каждым заголовком, которые будут давать ссылки на определенные разделы документации.
Каждый раз, когда нажимаются эти ссылки, часть заголовка будет меняться, и когда ваш клиент будет копировать и вставлять этот html, он будет направлять человека, которому он его отправляет, на этот конкретный раздел документации.
Далее "Отображение навигации в нижнем колонтитуле".
Этот плагин добавляет кнопку навигации в правом нижнем углу вашей Книги документации. Она выглядит примерно так.
Таким образом, вашим клиентам будет удобнее ориентироваться в вашей документации.
ЧАСТЬ 2:
Чтобы посмотреть часть 2 видеоурока, пожалуйста, посмотрите это видео здесь:
.
В этой части мы покажем плагин "Выделение кода", "Поиск" и "Поделиться в социальной сети".
Начнем с плагина 'Code Highlighting'.
Этот плагин отлично подходит для технических продуктов, которые должны выражать различные коды для своих клиентов. Этот плагин позволяет клиентам скопировать и вставить выделенный код, чтобы они могли использовать его в своем редакторе для удобства, добавив кнопку "Копировать".
Теперь давайте погрузимся в плагин Search.
После активации портала знаний Docsie ваши клиенты могут искать в вашей документации с помощью поисковой навигации в правом верхнем углу портала знаний.
Нажав на поиск, вы откроете сложную приборную панель, которая позволит вашим клиентам точно определить, где найти определенную информацию на ваших полках и в книгах.
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_8G9KP4zImdeOeNVMG/boo_NbQ7i8LYu6f7q4rnn/5e64c628-aa23-b6c3-d17c-499a87ea0265image.png)
Это значительно ускоряет процесс поиска и получения необходимой информации о вашей продукции.
Следующий плагин - Share To Social Networks.
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_0drhefPXvSjuyfjVF/boo_NbQ7i8LYu6f7q4rnn/382f6e99-41cc-698a-b66a-81ac9175b29cimage.png)
Этот плагин позволяет вашим клиентам захватывать выделенные разделы документации вашего продукта и делиться ими в своих социальных сетях.
Это замечательно, потому что может увеличить трафик, новых потенциальных клиентов и общее доверие к вашему бренду.
ЧАСТЬ 3:
Для того, чтобы посмотреть часть 3 видеоурока, пожалуйста, посмотрите это видео здесь:
.
В третьей части мы покажем плагин 'Image Preview', 'Document Metadata' и 'Auto-highlight Section'.
Начнем с плагина предварительного просмотра изображений
Предварительный просмотр изображений позволяет вашим клиентам увеличивать или уменьшать изображение документации вашего продукта, чтобы лучше его рассмотреть.
Далее 'Метаданные документации'
позволяет нашим клиентам видеть отметку времени, когда документация по продукту или аспекты портала знаний были обновлены. Она будет расположена в верхней и нижней части документации.
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_XuX34nMuBsiRqXWVJ/boo_NbQ7i8LYu6f7q4rnn/89db1bbb-c9bf-50e9-5344-36717448c436image.png)
Теперь давайте рассмотрим плагин 'Auto-Highlight Section Plugin
Этот простой плагин позволяет вашим клиентам отслеживать, где они находятся в той или иной документации на портале знаний.
Это позволит выделить каждый раздел, в котором они находятся, на портале знаний, чтобы клиенты yo8ru могли лучше отслеживать, в каком разделе они находятся, и легче ориентироваться в других разделах.
Все эти и другие инструменты предоставляет вам платформа Docsie. Если вы еще не попробовали ее, мы советуем вам это сделать. Нажмите здесь
Также, если у вас есть вопросы, пожалуйста, свяжитесь с нами по адресу hello@docsie.io.