Создание онлайн документации: Docsie.io Blog — 13 лучших платформ для создания онлайн-документации

Содержание

Docsie.io Blog — 13 лучших платформ для создания онлайн-документации

![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_3UC5tQiPT7j1Phyta/boo_YN22rC95nv3OY2Xaw/1c753e25-8c1a-b459-8567-63defe7641c4Main_picture1.png)

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

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

*Примите во внимание, что перечисленные ниже платформы расположены в алфавитном порядке и не отражают рейтинг.

1. Archbee

Поддержка клиентов:

  • Онлайн-чат, SLA 99,9% (не гарантируется)

Ценообразование:

  • Бесплатный начальный уровень предлагает неограниченное количество документов в 2 коллекциях, хранилище 1 ГБ и поддержку интеграции. Платные уровни Growing и Scaling предоставляют дополнительных пользователей, неограниченные коллекции и пользовательские домены. Для начального уровня нет гарантии SLA. [См. ценообразование] (https://www.archbee.io/pricing)

Обучение:

  • Тур по продукту, обучение продажам. Documentation

Краткое описание: Archbee помогает разработчикам и предприятиям создавать документацию для сложных продуктов и услуг. Процесс упрощается с помощью редактора «что видишь — то и получаешь» (WYSIWYG) для создания документов методом перетаскивания. Кроме того, в нем есть глобальный поиск с индексацией в реальном времени.

Archbee поддерживает списки, контрольные списки, таблицы, вызова, мини-задачи, загрузку файлов, изображений и видео, интеграцию карт, многоязычное редактирование кода и диаграммы. Другие интеграции включают Mermaid.js, Swagger, GraphQL, журналы изменений и встраивание HTML iFrame.

Бизнес-функции включают контроль доступа, управление изменениями и историю версий, совместную работу с помощью комментирования и редактирования в реальном времени, а также защиту паролем даже документов с внешним интерфейсом.

Лучшее решение для: Документы по продуктам вашего домена, ссылки на API, руководства для разработчиков, внутренние вики, базы знаний, диаграммы.

Рейтинг Каптерры: 4.7/ 5

2. Confluence

Поддержка клиентов:

  • Онлайн-чат и электронная почта, База знаний, форум сообщества

Ценообразование:

  • Confluence имеет бесплатный уровень, а также платные уровни Standard, Premium и Enterprise. См. ценообразование

Обучение:

  • Обучение и сертификация, форум сообщества, Документация

Краткое описание: Confluence 1.0 был запущен компанией Atlassian 25 марта 2004 года. Его целью было создание корпоративной системы управления знаниями, которая сохраняет силу вики в своей основе — мощную простоту.

Confluence является открытой и коллективной системой, обеспечивающей беспрепятственный доступ к документам и обмен файлами между сотрудниками. Это помогает командам создавать, управлять и совместно работать над проектами — от запуска продуктов до маркетинговых кампаний. Выделенные рабочие пространства позволяют сегментировать и распределять информацию по категориям, предоставлять подробные разрешения и обеспечивать совместную работу всех команд. Кроме того, Confluence интегрируется с более широким семейством продуктов Atlassian и приложениями на Atlassian Marketplace.

Глобальный поиск с интуитивно понятной иерархией страниц — одна из особенностей Confluence. В нем также есть ober75 настраиваемых шаблонов для планирования документации и создания отчетов. Confluence интегрируется с Jira для отслеживания ошибок и Agile-разработки. Это достигается с помощью коннекторов, которые позволяют отслеживать проблемы и динамически обновлять дорожную карту. Пользователи Confluence могут контролировать доступ к собственным документам, а администраторы рабочих пространств контролируют более широкий доступ к данным. Наконец, персональная лента доставляет соответствующие обновления пользователям на главной приборной панели, информируя их о проектах, задачах, последних файлах и последних контактах.

Лучшее применение: Внутренняя проектная документация

Рейтинг Каптерры: 4.4/ 5

3. Docsie

Поддержка клиентов:

  • Поддержка по электронной почте, База знаний, Поддержка по телефону

Ценообразование:

  • У Docsie есть бесплатный план Startup, а также 4 дополнительных платных плана, предназначенных последовательно для малого, среднего и крупного бизнеса. **See Pricing**

Обучение:

  • демонстрация/просмотр при входе в систему, конференц-связь, учебники на Youtube

Краткое описание: Первая альфа-версия Docsie была запущена в мае 2018 года. Docsie — это более разумный способ создания потрясающей документации по продуктам. Цель Docsie — помочь предприятиям писать лучшую документацию по продуктам.

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

Docsie предлагает универсальную функцию поиска по всем документам и рабочим пространствам. Портал Docsie доступен для собственного хостинга в рамках тарифного плана Docsie, а также для самостоятельного хостинга с использованием Docsie Script и прилагаемого руководства по стилизации Docsie. Docsie предоставляет множество плагинов и дополнений, которые позволяют создавать универсальную и динамичную онлайн-документацию. Docsie можно использовать как для внутренней, так и для внешней документации. Он позволяет перетаскивать материалы, а также создавать защищенные страницы с проверкой по веб-маркеру JSON (JWT). Docsie также имеет инструмент обратной связи под названием Vocally, который позволяет собирать текстовые отзывы и записывать видеоролики взаимодействия с пользователем, помогая вам итерационно улучшать вашу документацию.

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

Рейтинг Каптерры: 4.7/ 5

4. Document360

Поддержка клиентов:

  • Поддержка по электронной почте

Ценообразование:

  • Нет бесплатных уровней. Цены начинаются от $49 за проект в месяц для начального уровня, Business — $149, Enterprise — $299 и Enterprise Plus — опции для пользовательских соглашений. [См. ценообразование] (https://document360.com/pricing/)

Обучение:

  • Заказать демонстрацию, Документация

Краткое описание: Document360 была основана в 2017 году после 14-дневного хакатона и имеет штаб-квартиру в Лондоне, Великобритания. Document360 — это система управления знаниями специально для индустрии программного обеспечения как услуги (SaaS). Основанная в облаке, Document360 предоставляет базу знаний самообслуживания для клиентов и внутренних сотрудников.

Она поддерживает авторскую разработку и темы со встроенной аналитикой, а также резервное копирование, восстановление и мониторинг версий корпоративного уровня.

Document360 позволяет управлять несколькими базами знаний из одного места. Аналитика фильтрует данные и создает отчеты по документации, помогая авторам писать более качественную документацию. Разрешения на доступ к данным предотвращают несанкционированный доступ к ним, а частная документация защищена паролями или маркерами доступа. Наконец, функция поиска индексирует результаты в интегрированных приложениях, обеспечивая поиск в Disqus, Intercom, Zendesk, сервисах Google и других.

Лучшее для: Создание базы знаний для использования в индустрии программного обеспечения как услуги.

Рейтинг Каптерры: Нет отзывов

5. Documize

Поддержка клиентов:

  • Поддержка по электронной почте, База знаний

Ценообразование:

  • Documize поддерживает до 10 пользователей в бесплатной пробной версии. После этого, по мере увеличения числа пользователей, взимается ежемесячная плата за подписку. [См. ценообразование] (https://www.documize.com/pricing/)

Обучение:

  • Тур по функциям, документация штаб-квартиры для обучения.

Краткое описание: Компания Documize была основана в феврале 2014 года. Он организует существующие документы Word, хранящиеся в компаниях, и делает их доступными для поиска. Это позволяет расширить сотрудничество и поиск информации, используя уже существующую библиотеку документации.

С помощью Documize компании могут создать базу знаний, используя существующие документы Word. Стандартные параметры шаблонов позволяют вырезать и вставлять фрагменты, что помогает создать более обширную библиотеку знаний. Внутри документов пользователи могут добавлять насыщенный текст, фрагменты кода, разметку, доски Jira или Trello и многое другое.

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

Лучшее для: Импортирование документов Word и создание базы знаний с возможностью поиска.

Рейтинг Каптерры: 4.6/ 5

6. Gitbook

Поддержка клиентов:

  • Поддержка по электронной почте, присутствие на GitHub.

Ценообразование:

  • Проекты с открытым исходным кодом получают бесплатный доступ к GitBook. Планы Team начинаются от $6,40 за пользователя в месяц (минимум 5 пользователей), затем Business — от $12 за пользователя в месяц (минимум 20 пользователей) и Enterprise с индивидуальным ценообразованием — от $400.

Обучение:

  • Возможность заказать демонстрацию. В противном случае обучение проводится через документацию.

Общая информация: GitBook был основан в 2014 году, штаб-квартира находится в Лионе, Франция. GitBook начинался как решение с открытым исходным кодом для документации проектов GitHub.

GitBook помогает командам разработчиков документации продуктов организовывать, обмениваться и публиковать знания с помощью централизованной платформы документации. Это включает в себя внутреннюю и внешнюю документацию. GitBook поддерживает все текстовые форматы, бесчисленное количество языков программирования и видео- или графический контент. Он помогает авторам разрабатывать и публиковать документацию без развитых навыков проектирования или кодирования. Интеграция с GitHub позволяет синхронизировать документы, обновляя их по мере изменения кода в хранилище. Это включает поддержку сохранения/слияния для асинхронных обновлений и совместную работу пользователей в режиме реального времени. GitHib полностью бесплатен для проектов с открытым исходным кодом, некоммерческих организаций и студентов.

Лучшее для: Создание решения с открытым исходным кодом для разработчиков для публикации материалов в git-репозитории.

Оценка: 5/5

7. Гуру

Поддержка клиентов:

  • Help Center, Email, Live Chat

Ценообразование:

  • Неограниченное количество бесплатных «легких пользователей» с доступом только для чтения или платные планы Starter, Builder и Expert. См. ценообразование

Обучение:

  • Академия Гуру для видеокурсов, Форум сообщества и область FAQ, Сеть разработчиков.

Общая информация: Guru была основана в 2013 году, ее штаб-квартира находится в Филадельфии, штат Пенсильвания. Guru — это решение для управления знаниями, ориентированное на совместную работу. Это первая в мире сеть «расширения возможностей доходов», которая использует искусственный интеллект для повышения эффективности продаж, поддержки и успешной работы команды клиентов.

Guru позволяет создавать бизнес-вики, согласованные с существующими рабочими процессами. Это обеспечивает сотрудникам доступ ко всем необходимым знаниям, необходимым для выполнения их должностных обязанностей. Guru позволяет создавать, совместно использовать и редактировать документацию на платформе из внешних источников, интегрируя ее с существующими рабочими процессами. Это включает контекстно-релевантную, проверенную экспертами информацию в Slack, Microsoft Teams и электронной почте, а также инструменты управления взаимоотношениями с клиентами (CRM). Редактор Guru позволяет импортировать, форматировать и редактировать существующую документацию или создавать документацию с нуля с помощью функции экспорта.

Лучшее для: Создание бизнес-вики для внутреннего использования

Рейтинг Каптерры: 4.6/ 5

8. Notion Team Wiki

Поддержка клиентов:

  • Веб-поддержка по электронной почте. Чат доступен в приложении.

Ценообразование:

  • Персональный уровень бесплатный (с ограничением в 1000 блоков). Personal Pro и Teams — платные уровни, предназначенные для соло-предпринимателей и фрилансеров. Наконец, Enterprise предназначен для крупных компаний и предлагает SLA и выделенного линейного менеджера. [См. ценообразование] (https://www.notion.so/pricing)

Обучение:

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

Краткое описание: Компания Notion была основана в 2013 году, ее штаб-квартира находится в Сан-Франциско, штат Калифорния. Notion был создан, чтобы помочь компаниям с заметками, задачами, вики и базами данных. Программное обеспечение объединяет множество распространенных рабочих приложений в одно, что делает его универсальным средством для ведения заметок, управления задачами и проектами. Веб-приложение доступно для большинства современных браузеров, а также специальные пакеты приложений для Android и iOS.

Notion Team Wiki разработан как централизованное хранилище документации команды. Сюда входят документы, начиная от политики офисной работы и заканчивая целями и задачами компании. Другие элементы могут включать контактную информацию сотрудников, документы по инженерной практике, а также централизованный портал знаний для сотрудников и клиентов. Он позволяет пользователям перетаскивать списки, изображения, встроенный контент и видео с помощью WYSIWYG-редактора. Notion также поддерживает вложенность страниц с многоуровневым контролем доступа. Кроме того, Team Wiki от Notion позволяет обмениваться рабочими пространствами с группами разработчиков документации, обеспечивая совместную работу с комментариями и прямыми упоминаниями пользователей. Этими рабочими пространствами можно делиться внутри компании, за ее пределами или обоими способами с широкими возможностями в зависимости от того, как настроены права доступа.

Лучшее решение для: Создание внутренней документации по продуктам.

Оценка Каптерры: 4.7/ 5

9. Nuclino

Поддержка клиентов:

  • Электронная почта, База знаний

Ценообразование:

  • Базовый БЕСПЛАТНЫЙ уровень с 50 элементами и 2 ГБ общего хранилища. Платный уровень позволяет неограниченное количество элементов и 10 ГБ хранилища на пользователя. [См. ценообразование] (https://www.nuclino.com/pricing)

Обучение:

  • Доступен учебный центр, предоставляющий обзор платформы в различных бизнес-контекстах (HR, продукты, проекты).

Краткое описание: Компания Nuclino была основана в 2015 году, штаб-квартира находится в Мюнхене, Германия. Nuclino — это простое и отзывчивое решение для командной вики в режиме реального времени, которое обеспечивает более высокую производительность и сотрудничество. Команды могут записывать, делиться и находить знания «на лету», с возможностью отслеживать действия членов команды в режиме реального времени при редактировании и поиске.

Nuclino поддерживает изображения, текст, видео, управление задачами, встроенные веб-элементы и блоки кода. Кроме того, в нем встроена поддержка формата markdown. Все технические записи отмечаются временными метками с историей версий, а изменения пользователей видны в режиме реального времени. Nuclino разработан таким образом, чтобы несколько пользователей могли беспрепятственно работать над одной страницей, что упрощает отслеживание изменений и обратную связь. Функция поиска использует индексирование и кэширование для мгновенного получения результатов поиска, а контекстные фильтры обеспечивают расширенный поиск. Nuclino также позволяет визуально представлять элементы с помощью досок и графиков.

Лучшее для: Создание базы знаний для обмена информацией

Каперский рейтинг: 4.6/ 5

10. Readme

Поддержка клиентов:

  • Поддержка по электронной почте, онлайн-чат

Ценообразование:

  • Бесплатный уровень поддерживает 3 версии API и 5 пользователей-администраторов в одном проекте. Платные уровни начинаются от $99 за проект в месяц. [См. ценообразование] (https://readme.com/pricing)

Обучение:

  • База знаний, Виртуальный тур, Поддержка клиентов.

Общая информация: Компания Readme была основана в 2014 году, штаб-квартира находится в Сан-Франциско, Калифорния. Readme — это полностью конфигурируемая платформа для совместного документирования. Она ориентирована на динамическое документирование API и программного обеспечения. Пользователи могут взаимодействовать с API напрямую, используя знакомый инструмент проектирования Swagger и файлы OAS. Также имеется редактор разметки и поддержка создания тем.

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

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

Лучшее для: Создания документации по API или программному обеспечению

Каперский рейтинг: Нет отзывов

11. ReadtheDocs

Поддержка клиентов:

  • Сообщество с открытым исходным кодом, фокус на исправлении ошибок и поддержке сообщества. Версия для сообщества имеет ограниченную бесплатную поддержку. Бизнес-версия предлагает приоритетную поддержку.

Ценообразование:

  • ReadtheDocs имеет 3 уровня: Basic, Advanced и Pro. [См. ценообразование] (https://readthedocs.com/pricing/)

Обучение:

  • База знаний и обучающие сообщества. Сообщества Stack Overflow и Github.

Краткое описание: Компания ReadtheDocs была основана 1 января 2017 года в Портленде, штат Орегон.

ReadtheDocs — это онлайн-платформа, предлагающая услуги по документированию для сообщества разработчиков открытого кода и предприятий. Эти услуги включают разработку с открытым исходным кодом, обслуживание, интеграцию платформы, обзор процесса документирования и консультации. Разработка с открытым исходным кодом включает интеграцию ReadtheDocs, sphinx, расширений sphinx и разработку на языке python. Интеграция платформ осуществляется путем автоматической генерации ссылок на API и текста в формате разметки.

ReadtheDocs предлагает помощь более чем 100 000+ проектов с открытым исходным кодом, позволяя размещать документацию и обмениваться ею, используя пользовательский домен и стиль. Они позволяют своим пользователям автоматизировать процесс создания, версионирования и размещения документации по программному обеспечению. Когда вы загружаете код на предпочитаемый сервер контроля версий, такой как GitHub или GitLab, ReadtheDocs автоматически создает, обновляет и синхронизирует вашу документацию. Помимо создания и размещения документов в Интернете, ReadtheDocs может экспортировать PDF, одностраничные HTML и ePub файлы для использования в устройствах для электронного чтения. ReadtheDocs позволяет пользователям создавать несколько версий документации — например, версию 1, версию 2 — просто создав отдельную ветку или тег в вашей системе контроля версий.

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

Рейтинг Каптерры: 4. 6/ 5

12. Slab

Поддержка клиентов:

  • Билет по электронной почте

Ценообразование:

  • Уровень Slab Free позволяет 10 пользователям и 90 дней истории версий, хотя и имеет ограничение на размер файла 10 МБ и не допускает гостей. Startup и Business снимают эти ограничения по цене $6,67 и $12,50 соответственно за пользователя в месяц. Бизнес также имеет преимущество в виде SLA на время безотказной работы. [См. ценообразование] (https://slab.com/pricing/)

Обучение:

  • Справочный центр и Библиотека ресурсов

Резюме:

Компания Slab была основана в августе 2016 года в Сан-Франциско, Калифорния. Slab предназначен для современных компаний, которым нужны современные базы знаний. Компании используют Slab для обмена учебными материалами и документацией как внутри компании, так и за ее пределами.

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

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

Рейтинг Каптерры: Нет отзывов

13. Руководство по Zendesk

Поддержка клиентов:

  • Справочный центр, электронная почта, чат

Ценообразование:

  • Zendesk имеет три пакета, Suite Team, Suite Growth и Suite Professional. Есть бесплатная пробная версия, но нет бесплатного варианта. [См. ценообразование] (https://www.zendesk.com/pricing/#everyone)

Обучение:

  • Zendesk проводит целевое обучение для сотрудников, а также предлагает сертификацию для консультантов и поставщиков услуг.

Резюме: Компания Zendesk начала свою деятельность в 2007 году и базируется в Сан-Франциско, штат Калифорния. Zendesk поддерживает более 150 000 клиентов на более чем 30 языках в сотнях отраслей. Zendesk — это платформа для обслуживания клиентов, которая производит программное обеспечение, позволяющее организациям и их клиентам более эффективно сотрудничать. Она позволяет предприятиям повысить уровень взаимодействия с потребителями и глубже понять своих клиентов. Продукты Zendesk просты в использовании и внедрении. Они позволяют компаниям быстро развиваться, фокусироваться на инновациях и расширяться в соответствии со своим ростом.

Zendesk guides предназначен для превращения информации из чата помощи Zendesk в руководства для пользователей. Он разработан на основе преобразования всей письменной информации справочного руководства в портал знаний для этой цели. Она может быть опубликована в вашем справочном центре, веб-виджете, мобильном SDK. приложении или в любом другом, куда вы можете подключить эту информацию. Руководство также может решать тикеты с помощью своего Zenbot, который позволяет задавать вопросы вашим клиентам. Zendesk Guides также позволяет вам локализовать знания о помощи на 40 различных языках.

Компания Zendesk начала свою деятельность в 2007 году из Сан-Франциско, Калифорния.

Zendesk известен как платформа для успешной работы с клиентами, поддерживающая 150 000+ клиентов на 30 различных языках во всех отраслях. Она позволяет оказывать услуги по поддержке клиентов через системы тикетов по электронной почте, чат и телефон.

Zendesk Guides специально предназначен для работы с документацией и входит в любой тарифный план Zendesk. Это база знаний самообслуживания для компаний, которая может хранить и обслуживать сотни документов и руководств пользователя по всему миру. В экосистеме Zendesk это включает автоответы со статьями базы знаний для тикетов поддержки по электронной почте и подробные показатели отчетности.

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

Оценка Каптерры: 4.4/5

Делайте правильно! Публикуем онлайн-документацию на сайте проекта :: Статьи

Журавлев Денис

Формат онлайн-документации


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


В некоторых программах по созданию документации (HAT — Help Authoring Tools) данный формат называется webhelp. Некоторые пакеты генерируют онлайн-документацию с элементами HTML5, но принципиально это дела не меняет — онлайн-справка является частью сайта, разбитой на страницы-разделы, для просмотра которых требуется веб браузер и постоянный доступ в интернет.


Разделение на страницы и требование наличия постоянного доступа в интернет и является проблемой формата webhelp. Пользователь не может работать с документацией в режиме offline, а также не может просмотреть или распечатать в одно действие весь документ целиком. Поэтому, вместе с традиционной онлайн-справкой рекомендуется выложить на сайт всю документацию единым файлом, например, в формате PDF. При желании, пользователь сможет скачать этот файл и работать с ним в offline режиме практически на любом устройстве, а распечатка всей документации теперь будет делом пары кликов.





Большинство современных HAT-программ, таких как Dr.Explain, умеют создавать документы в различных форматах (например, webhelp и PDF) из одного проекта-источника без дополнительных трудозатрат с вашей стороны.



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


Навигация по документации



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



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




Аннотация скриншота сделана встроенными средствами программы Dr.Explain




Оглавление


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


«Хлебные крошки» (Bread crumbs)


«Хлебные крошки» показывают список родительских разделов для данной страницы. С их помощью пользователь может быстро понять, в какие более глобальные разделы входит конкретная тема, и кликом перейти в один из них.


Линейная навигация


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


Связанные разделы и подразделы


Список связанных разделов («Смотри также») и список подразделов текущей темы можно разместить в конце страницы. Такая «подборка» помогает пользователю быстро найти дополнительную информацию по интересующем его вопросу, не прибегая к функции поиска.


Поиск


О важности функции поиска в документации, разбитой на отдельные страницы, можно даже не говорить. Реализовать поиск можно как сторонними средствами, например, такими, как Google Site Search, так и самописными скриптами. Однако, если вы создаете документацию в профессиональной HAT-программе, эту функцию вы получите «из коробки». Например, при создании онлайн-справки в программе Dr.Explain функция поиска будет включена по умолчанию. При этом на стороне сервера не потребуется никаких специфических настроек хостинга, подключения базы данных или дополнительных скриптов. Полнотекстовый индекс создается в Dr.Explain на этапе экспорта, а сам функционал поиска реализован на JavaScript. Таким образом, поиск будет работать в любом интернет-бразуере при том, что саму онлайн-справку можно разместить даже на бесплатном хостинге с самым аскетичным набором опций или на простом компьютере в локальной сети.


Брендирование и интеграция с сайтом проекта

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



Говоря про навигацию в онлайн-справке, надо отметить и SEO-фактор. Грамотная навигация очень сильно связывает взаимными ссылками, т.е. перелинковывает, отдельные страницы. Перелинковка способствует быстрой индексации документации поисковыми роботами и, соответственно, попаданию ее страниц в поисковую выдачу по релевантным запросам.


Удобство использования



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



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



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





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



Взаимодействие с пользователями



Помимо основной цели — помощи пользователям в работе с продуктом — документация может также выполнять роль маркетингового инструмента и средства общения с пользователями.



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



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





Создавая документацию в Dr.Explain, вы может добавить кнопки социальных сетей и возможность оставлять комментарии на страницах справки, практически, несколькими кликами.



Поисковая оптимизация (SEO)



Рассматривая маркетинговую функцию онлайн-документации, т.е. использование ее для привлечения новых пользователей и продвижения продукта на рынке, нельзя не затронуть вопрос SEO (Search Engine Optimization).


Онлайн-документация — это огромный массив информации, описывающей решение определенного класса задач с помощью вашего продукта. Люди, которые ищут в интернете решения этих задач, но еще не знакомы с вашим проектом — ваши потенциальные пользователи. Прочитав в вашей документации о том, как их задачи могут быть решены с помощью функций вашего продукта, они, скорее всего, захотят им воспользоваться. Единственный способ заполучить таких людей — сделать так, чтобы поисковые системы — Google, Yandex, Bing и т.д. — выдавали как можно чаще и ближе к началу списка ссылку на страницы вашей онлайн-справки по фразам, связанным с описанием пользовательских проблем. Например, «как оптимизировать палитру PNG-изображения без потери качества».


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




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



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



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



Перелинковывайте страницы документации. Ставьте в тексте раздела ссылки на другие разделы документации, при этом в тексте ссылок используйте ключевые фразы (например, «Изменить размер изображения»), а не слова-пустышки (например, «нажмите тут» или «здесь»).




Создавайте каждую тему в отдельном файле с ключевыми словами в имени файла. Каждая тема вашей онлайн-справки должна иметь уникальное имя файла, а, в итоге, и уникальный URL, чтобы поисковик мог на нее сослаться. Чтобы повысить рейтинг именно вашей странице в выдаче поисковой системы, дайте ей осмысленное имя. Например, «reduce-image-size-by-limiting-colors.html» более предпочтительное название, чем «page_34-838-b.htm». Кстати, программа Dr.Explain автоматически формирует имена файлов на основе названия тем. Это удобно.


Расположение



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



Например, онлайн-справку часто располагают в каталогах сайта с именами help, doc или manual. Соответственно, если каталог с онлайy-справкой называется help, то пользователю она будет доступна по адресу http://www.product.com/help/




или




Кстати, не забудьте включить в вашу документацию индексный файл (index.htm, index.html и т.д.). Тогда входной точкой будет именно адрес http://www.product.com/help/, а не http://www.product.com/help/intial_page.htm или что-то иное. Это удобно для пользователя. Удачной идеей будет разместить в индексном файле титульную страницу вашей документации. Именно так поступает программа Dr.Explain, при генерации онлайн-справок.



Если документация является важной частью вашего проекта, и к ней постоянно обращается много пользователей, то, возможно, есть смысл вынести ее на отдельный поддомен — например, http://help.product.com





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


Доступность



После того, как вы разработали отличную онлайн-документацию для своего проекта и опубликовали ее на сайте, остается задать себе еще один вопрос: «Насколько легко пользователи смогут найти онлайн-справку?»


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


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



Еще раз повторим, что рядом с полноценной онлайн документацией не помешает опубликовать ссылки на печатную или offline версию документации, например, в формате PDF или CHM. Кстати, программа Dr.Explain может создавать документацию в различных форматах из одного проекта. Это позволит пользователям не зависеть от наличия интернет-соединения и скачать всю документацию одним файлом для распечатки или локального чтения на своем устройстве.





Более подробно о том, почему пользователям бывает сложно пользоваться документацией читайте в статье 16 причин, почему ваши пользователи не читают документацию



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


Смотрите также

  • 16 причин, почему ваши пользователи не читают документацию
  • Dr.Explain — инструмент для создания мобильной версии пользовательской документации к программным продуктам

Блог Docsie.io — 13 лучших онлайн-платформ для создания документации

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

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

Обратите внимание, что платформы, перечисленные ниже, расположены в алфавитном порядке и не отражают рейтинг.

1. Archbee

Служба поддержки:

  • Онлайн-чат, целевое значение SLA 99,9% (не гарантируется)

Цена:

  • Бесплатный начальный уровень предлагает неограниченное количество документов в 2 коллекциях, 1 ГБ хранилища и поддержку интеграции. Рост и масштабирование — это платные уровни с дополнительными пользователями, неограниченными коллекциями и персональными доменами. Отсутствие гарантии SLA для начального уровня. См. цены

Обучение:

  • Знакомство с продуктом, ввод в курс продаж. Документация

Резюме: Archbee помогает разработчикам и предприятиям создавать документацию для сложных продуктов и услуг. Этот процесс упрощается благодаря использованию редактора «что видишь, то и получишь» (WYSIWYG) для построения документа методом перетаскивания. Он также имеет глобальный поиск с индексацией в реальном времени.

Archbee поддерживает списки, контрольные списки, таблицы, выноски, мини-задачи, загрузку файлов, изображения и видео, интеграцию карт, многоязычное редактирование кода и диаграммы. Другие интеграции включают Mermaid.js, Swagger, GraphQL, журналы изменений и встраивание HTML iFrame.

Бизнес-функции включают контроль доступа, управление изменениями и историю версий, совместную работу посредством комментирования и редактирования в реальном времени и, наконец, защиту паролем даже при работе с внешними документами.

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

Рейтинг Capterra: 4,7/ 5

2. Confluence

Служба поддержки:

  • Онлайн-чат и электронная почта, база знаний, форум сообщества

Цены:

  • У Confluence есть бесплатный уровень наряду с платными уровнями Standard, Premium и Enterprise. См. цены

Обучение:

  • Обучение и сертификация, форум сообщества, документация

Сводка: Confluence 1. 0 была запущена компанией Atlassian 25 марта 2004 года. Ее целью было создание корпоративной системы управления знаниями, в основе которой лежит мощь вики — мощная простота.

Confluence является открытой и совместной, обеспечивая беспрепятственный доступ к документам и обмен файлами между сотрудниками. Это помогает командам создавать, управлять и совместно работать над проектами, начиная от запуска продукта и заканчивая маркетинговыми кампаниями. Выделенные рабочие области позволяют сегментировать и классифицировать информацию с детализированными разрешениями и совместной работой между командами. Кроме того, Confluence интегрируется с более широким семейством продуктов Atlassian и приложениями на Atlassian Marketplace.

Глобальный поиск с интуитивно понятной иерархией страниц — одна из функций Confluence. Он также имеет настраиваемые шаблоны ober75 для планирования документации и создания отчетов. Confluence интегрируется с Jira для отслеживания ошибок и гибкой разработки. Это достигается с помощью соединителей, которые позволяют отслеживать проблемы и динамически обновлять дорожную карту. Пользователи Confluence могут контролировать доступ к своим документам, а администраторы рабочей области контролируют более широкий доступ к данным. Наконец, личный канал предоставляет пользователям актуальные обновления на главной панели инструментов, информируя их о проектах, задачах, последних файлах и последних контактах. 9 4.4/ 5

Цены:

  • У Docsie есть бессрочный бесплатный план Startup и 4 дополнительных платных плана, последовательно ориентированных на малый, средний и крупный бизнес. **См. цены**

Обучение:

  • Вводная демонстрация / пошаговое руководство, конференц-связь, учебные пособия по YouTube

Сводка: Первая альфа-версия Docsie была запущена в мае 2018 года. Docsie — это более разумный способ создания потрясающей документации по продукту. Цель Docsie — помочь предприятиям писать лучшую документацию по продуктам.

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

Docsie предлагает универсальные функции поиска по всем документам и рабочим пространствам. Портал Docsie доступен для собственного хостинга в рамках плана Docsie, а самостоятельный хостинг доступен с использованием Docsie Script и прилагаемого руководства по стилю Docsie. Docsie предоставляет множество плагинов и надстроек, которые позволяют создавать универсальную и динамичную онлайн-документацию. Docsie можно использовать как для внутренней, так и для внешней документации. Он позволяет использовать возможности перетаскивания, а также безопасные страницы с проверкой веб-токена JSON (JWT). У Docsie также есть инструмент обратной связи под названием Vocally, который позволяет вам собирать текстовые отзывы и записывать видео взаимодействия с пользователем, помогая вам повторять и улучшать вашу документацию.

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

Рейтинг Capterra: 4,7/ 5

4. Document360

Служба поддержки клиентов:

  • Поддержка по электронной почте

Цены:

  • Нет бесплатных уровней. Цены начинаются с 49 долларов США за проект в месяц для вариантов Startup, Business 149 долларов США, Enterprise 299 долларов США и Enterprise Plus для индивидуальных соглашений. См. цены

Обучение:

  • Заказать демонстрацию, документация

Резюме: Document360 была основана в 2017 году после 14-дневного хакатона, ее штаб-квартира находится в Лондоне, Великобритания. Document360 — это система управления знаниями, специально предназначенная для отрасли «Программное обеспечение как услуга» (SaaS). Находясь в облаке, Document360 предоставляет базу знаний самообслуживания для клиентов и внутреннего персонала.

Он поддерживает создание и темы со встроенной аналитикой и резервным копированием, восстановлением и контролем версий корпоративного уровня.

Document360 позволяет управлять несколькими базами знаний из одного места. Аналитика фильтрует данные и создает отчеты о документации, чтобы помочь авторам писать более качественную документацию. Разрешения на доступ к данным предотвращают несанкционированный доступ к данным, а личная документация защищена паролями или токенами доступа. Наконец, функция поиска индексирует результаты по интегрированным приложениям, позволяя выполнять поиск в службах Disqus, Intercom, Zendesk и Google для выбора названия.

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

Capterra Рейтинг: Нет отзывов

5. Documize

Служба поддержки:

  • Поддержка по электронной почте, база знаний

Цена:

  • Бесплатная пробная версия Documize поддерживает до 10 пользователей. Помимо этого, ежемесячная стоимость подписки применяется по мере увеличения количества пользователей. См. цены

Обучение:

  • Feature Tour, штаб-квартира документации для адаптации.

Сводка: Documize была основана в феврале 2014 года. Она упорядочивает существующие документы Word, хранящиеся в компаниях, и делает их доступными для поиска. Это обеспечивает более эффективное сотрудничество и поиск информации с использованием уже существующей библиотеки документации.

С помощью Documize предприятия могут создавать базы знаний, используя существующие документы Word. Параметры шаблона по умолчанию позволяют вырезать и вставлять фрагменты, помогая расширить библиотеку знаний. В документы пользователи могут добавлять форматированный текст, фрагменты кода, разметку, доски Jira или Trello и многое другое.

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

Подходит для: Импорт документов Word и создание базы знаний с возможностью поиска

Capterra Рейтинг: 4,6/ 5

6. Gitbook

Служба поддержки клиентов:

  • Поддержка по электронной почте, наличие GitHub.

Цена:

  • Проекты с открытым исходным кодом получают бесплатный доступ к GitBook. Командные планы начинаются с 6,40 долларов США за пользователя в месяц (минимум 5 пользователей), за ними следуют бизнес-планы от 12 долларов США за пользователя в месяц (минимум 20 пользователей) и предприятия с индивидуальной ценой от 400 долларов США.

Обучение:

  • Возможность заказать демонстрацию. В противном случае обучение осуществляется посредством документации.

Резюме: GitBook была основана в 2014 году и имеет штаб-квартиру в Лионе, Франция. GitBook начинался как решение с открытым исходным кодом для проектной документации GitHub.

GitBook помогает командам разработчиков документации по продуктам организовывать, делиться и публиковать знания с централизованной платформы документации. Это включает в себя внутреннюю и внешнюю документацию. GitBook поддерживает все текстовые форматы, бесчисленное количество языков программирования, а также видео и изображения. Это помогает авторам разрабатывать и публиковать документацию без передовых навыков проектирования или кодирования. Интеграция с GitHub позволяет синхронизировать документы; обновление документов по мере изменения кода в репозитории. Это включает в себя поддержку сохранения/слияния для асинхронных обновлений и совместную работу между пользователями в режиме реального времени. GitHib полностью бесплатен для проектов с открытым исходным кодом, некоммерческих организаций и студентов.

Подходит для: Создание решения с открытым исходным кодом для разработчиков, позволяющее публиковать материалы в репозитории git.

Рейтинг Capterra: 5/5

7. Гуру

Служба поддержки:

  • Справочный центр, электронная почта, чат

Цены:

  • Неограниченное количество бесплатных «Легких пользователей» с доступом только для чтения или платными тарифными планами Starter, Builder и Expert. См. цены

Обучение:

  • Академия гуру для видеокурсов, форума сообщества и области часто задаваемых вопросов, сети разработчиков.

Резюме: Guru была основана в 2013 году и имеет штаб-квартиру в Филадельфии, штат Пенсильвания. Guru — это решение для управления знаниями, ориентированное на совместную работу. Это первая в мире сеть «расширения возможностей доходов», которая использует искусственный интеллект для повышения эффективности продаж, поддержки и работы с клиентами.

Guru позволяет создавать бизнес-вики в соответствии с существующими рабочими процессами. Это гарантирует, что сотрудники имеют доступ ко всем соответствующим знаниям, необходимым для выполнения их должностных обязанностей. Guru позволяет создавать, совместно использовать и редактировать документацию на платформе из внешних источников, интегрируясь с существующими рабочими процессами. Это включает контекстно-зависимую, проверенную экспертами информацию в Slack, Microsoft Teams и электронной почте, а также инструменты управления взаимоотношениями с клиентами (CRM). Редактор Guru позволяет импортировать, форматировать и редактировать существующую документацию или создавать документацию с нуля с функцией экспорта.

Подходит для: Создание бизнес-вики для внутреннего использования

Рейтинг Capterra: 4.6/ 5

8. Notion Team Wiki

Поддержка клиентов через Интернет:

    7

    Онлайн-чат доступен в приложении.

Цена:

  • Личный уровень бесплатный (с ограничением в 1000 блоков). Personal Pro и Teams — это платные уровни, предназначенные для индивидуальных предпринимателей и фрилансеров. Наконец, Enterprise предназначен для крупных предприятий и предлагает SLA и выделенного линейного менеджера. См. цены

Обучение:

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

Резюме: Notion была основана в 2013 году и имеет штаб-квартиру в Сан-Франциско, Калифорния. Notion был создан, чтобы помочь компаниям с заметками, задачами, вики и базами данных. Программное обеспечение объединяет множество обычных рабочих приложений в одно, что делает его универсальным средством для ведения заметок, управления задачами и управления проектами. Веб-приложение доступно в большинстве современных веб-браузеров с помощью специальных пакетов приложений для Android и iOS.

Notion Team Wiki предназначен для централизованного хранения документации команды. Это варьируется от документов политики офисной работы до целей и задач компании. Другие элементы могут включать контактную информацию сотрудников, документы по инженерной практике и централизованный портал знаний для сотрудников и клиентов. Он позволяет пользователям перетаскивать списки, изображения, встроенный контент и видео с помощью редактора WYSIWYG. Notion также поддерживает вложение страниц с многоуровневым контролем доступа. Кроме того, Team Wiki Notion позволяет вам делиться рабочими пространствами с командами документации, обеспечивая совместную работу с комментариями и прямыми упоминаниями пользователей. Эти рабочие пространства могут совместно использоваться внутри, снаружи или обоими способами с широкими возможностями в зависимости от того, как настроены разрешения.

Подходит для: Создание внутренней документации по продукту.

Рейтинг Capterra: 4,7/ 5

9. Nuclino

Служба поддержки:

  • Электронная почта, база знаний

Цена:

  • Базовый БЕСПЛАТНЫЙ уровень с 50 предметами и 2 Гб общей памяти. Платный уровень позволяет неограниченное количество элементов и 10 ГБ хранилища на пользователя. См. цены

Обучение:

  • Доступен учебный центр, предоставляющий обзор платформы в различных бизнес-контекстах (HR, продукты, проекты)

Краткое описание: Nuclino была основана в 2015 году, ее штаб-квартира находится в Мюнхене, Германия. Nuclino — это простое и гибкое командное вики-решение, работающее в режиме реального времени, которое обеспечивает более высокую производительность и совместную работу. Команды могут записывать, обмениваться и находить знания на лету, наблюдая за действиями членов команды в режиме реального времени при редактировании и поиске.

Nuclino поддерживает изображения, текст, видео, управление задачами, встроенные веб-элементы и блоки кода. Он также изначально поддерживает уценку. Вся техническая документация имеет отметку времени с историей версий, а пользовательские изменения можно увидеть в режиме реального времени. Nuclino предназначен для беспрепятственной работы нескольких пользователей над одной страницей, что упрощает отслеживание изменений и обратную связь. Функция поиска использует индексацию и кэширование для мгновенных результатов поиска с контекстными фильтрами для расширенного поиска. Nuclino также позволяет визуально представлять элементы с помощью досок и графиков. 9 4.6/ 5

Цена:

  • Уровень бесплатного пользования, поддерживающий 3 версии API и 5 пользователей-администраторов в одном проекте. Платные уровни начинаются с 99 долларов за проект в месяц. См. цены

Обучение:

  • База знаний, виртуальный тур, поддержка клиентов.

Резюме: Readme была основана в 2014 году, ее штаб-квартира находится в Сан-Франциско, Калифорния. Readme — это полностью настраиваемая платформа для совместной документации. Особое внимание уделяется динамическому API и документации по программному обеспечению. Пользователи могут взаимодействовать с API напрямую, используя знакомый инструмент проектирования Swagger и файлы OAS. Также есть редактор уценки и поддержка создания тем.

Функционирует как база знаний по API и документации по программному обеспечению. Пользователи могут писать в своих любимых инструментах разработки API и копировать реальный код прямо в свои документы. Версии и журналы изменений доступны для каждого документа. Readme поддерживает изображения, видео и встроенный контент, а также пользовательские фреймворки CSS.

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

Подходит для: Создание документации по API или программному обеспечению

Рейтинг Capterra: Нет отзывов

11. ReadtheDocs

Поддержка клиентов:

  • -9001 Версия сообщества имеет ограниченную бесплатную поддержку. Бизнес-версия предлагает приоритетную поддержку.

    • Цены:

    • ReadtheDocs имеет 3 уровня: базовый, расширенный и профессиональный. См. цены

    Обучение:

    • База знаний и преподаватели сообщества. Сообщества Stack Overflow и Github.

    Резюме: ReadtheDocs была основана 1 января 2017 года в Портленде, штат Орегон.

    ReadtheDocs — это онлайн-платформа, предлагающая услуги по документации сообществу разработчиков ПО с открытым исходным кодом и компаниям. Эти услуги включают в себя разработку с открытым исходным кодом, обслуживание, интеграцию с платформой, обзор процесса документации и консультации. Разработка с открытым исходным кодом включает в себя интеграцию ReadtheDocs, sphinx, расширений sphinx и разработку на python. Интеграция с платформой осуществляется за счет автоматического создания ссылок на API и текста уценки.

    ReadtheDocs предлагает поддержку более чем 100 000 проектов с открытым исходным кодом, позволяя размещать документацию и делиться ею с использованием пользовательского домена и стиля. Они позволяют своим пользователям автоматизировать процесс создания, управления версиями и размещения документации по программному обеспечению. Когда вы загружаете код на предпочитаемый вами сервер контроля версий, такой как GitHub или GitLab, ReadtheDocs автоматически создает, обновляет и синхронизирует вашу документацию. Помимо создания и размещения документов в Интернете, ReadtheDocs также может экспортировать PDF-файлы, одностраничные HTML-файлы и файлы ePub для использования с устройствами для чтения электронных книг. ReadtheDocs позволяет своим пользователям создавать несколько версий документации, например. версия 1, версия 2 — просто создав отдельную ветку или тег в вашей системе контроля версий.

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

    Рейтинг Capterra: 4,6/ 5

    12. Плита

    Служба поддержки:

    • Электронный билет

    Цены:

    • Уровень Slab Free позволяет иметь 10 пользователей и 90 дней истории версий, хотя с ограничением размера файла в 10 МБ и без гостей. Startup и Business снимают эти ограничения по цене 6,67 и 12,50 долларов США соответственно на пользователя в месяц. Бизнес также выигрывает от соглашения об уровне обслуживания безотказной работы. См. цены

    Обучение:

    • Справочный центр и библиотека ресурсов

    Краткое описание:

    Компания Slab была основана в августе 2016 года в Сан-Франциско, штат Калифорния. Slab предназначен для современных предприятий, которым нужны современные базы знаний. Компании используют Slab для обмена учебными материалами и документацией как внутри компании, так и за ее пределами.

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

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

    Рейтинг Capterra: Нет отзывов

    13. Zendesk Guide

    Служба поддержки:

    • Справочный центр, электронная почта, чат

    Цены:

    • Zendesk предлагает три пакета: Suite Team, Suite Growth и Suite Professional. Есть бесплатная пробная версия, но нет бесплатной опции. См. цены

    Обучение:

    • Zendesk проводит целевое обучение сотрудников и предлагает сертификацию для консультантов и поставщиков услуг.

    Сводка: Zendesk начал свою деятельность в 2007 году и базируется в Сан-Франциско, Калифорния. Zendesk поддерживает более 150 000 клиентов на более чем 30 языках в сотнях отраслей. Zendesk — это платформа обслуживания клиентов, которая производит программное обеспечение, позволяющее организациям и их клиентам более эффективно сотрудничать. Это позволяет предприятиям увеличить взаимодействие с потребителями и получить более глубокое понимание своих клиентов. Продукты Zendesk просты в использовании и развертывании. Они позволяют компаниям быстро двигаться, фокусироваться на инновациях и расширяться в соответствии со своим ростом.

    Руководства Zendesk предназначены для преобразования информации из справочного чата Zendesk в руководства пользователя, помогающие пользователям. Он разработан на основе преобразования всей письменной информации справочного руководства в портал знаний для этой цели. Его можно опубликовать в вашем справочном центре, веб-виджете, мобильном SDK, приложении или в любом другом месте, куда вы можете подключить эту информацию. Гид также может решать вопросы с помощью своего Zenbot, что позволяет задавать вопросы вашим клиентам. Zendesk Guides также позволяет вам локализовать свои справочные знания на 40 разных языках.

    Zendesk начал свою работу в 2007 году из Сан-Франциско, Калифорния.

    Zendesk известен как платформа успеха клиентов, поддерживающая более 150 000 клиентов на 30 различных языках во всех отраслях. Это позволяет службам поддержки клиентов через системы продажи билетов по электронной почте, чат и телефон.

    Zendesk Guides специально предназначен для документации и включен в любой план Zendesk. Это база знаний самообслуживания для компаний, которая может хранить и обслуживать сотни документов и руководств пользователя по всему миру. В экосистеме Zendesk это включает в себя автоответы со статьями базы знаний для обращений в службу поддержки по электронной почте и подробные показатели отчетности.

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

    Capterra Рейтинг: 4.4/5

    Создание онлайн-документации и руководств » Manula

    Подпишитесь на 7-дневную бесплатную пробную версию , с изображениями, встроенными видео и загружаемыми PDF-версиями.

    Создание и поддержка онлайн-документации

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

    Подробнее →

    Публикация документации в Интернете для любого размера экрана

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

      с логинами пользователя/пароля для читателей.

    Подробнее →

    Отслеживание статистики просмотров тем,

    пользовательских рейтингов и отзывов

    • Автоматическая статистика ручных просмотров и просмотров тем.
    • «Это было полезно?» голосование за читателей.
    • Разрешить читателям комментировать темы.
    • Отслеживайте все поисковые запросы пользователей, чтобы найти ключевые слова.
    • Оценка качества темы по рейтингу пользователей.
    • Ссылка на Google Analytics для получения дополнительной статистики.

    Подробнее →

    “ Это фантастический инструмент! Я собираюсь выпустить версию 2 MeetingKing и узнал о Мануле.

    Я планировал просто создать файлы руководства/справки в WordPress, но это оказалось намного проще.

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

    Почти весело (почти) создавать файлы справки. У него достаточно опций, чтобы он выглядел так, как вам нравится, но он не перегружен и не сбивает с толку. На самом деле программное обеспечение настолько простое, что может обойтись без руководства! — Эдвин Сибесма (MeetKing), США

    Создавайте профессионально выглядящую онлайн-документацию в кратчайшие сроки

    Отформатируйте свои темы, используя простые текстильные коды (*) и хэши (#) для обычных и нумерованных списков.

    Место h2., h3. перед строкой для создания заголовков. Это не становится легче, чем это.

    Удобная загрузка, управление и вставка изображений с помощью диспетчера изображений

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

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

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

    Совместное использование тем в руководствах для облегчения обслуживания

    Есть несколько продуктов, которые похожи или имеют общие функции? Затем создайте общие темы (не копии!) и включите их в несколько документов.

    Определите свои собственные переменные для использования в общих темах

    Определите свои собственные переменные (например, {APPNAME}) и установите их значения по-разному для каждого руководства пользователя. Теперь включите переменные в общие темы, чтобы они отображались по-разному в каждом руководстве.

    Публикуйте свою документацию в Интернете — для любого устройства, размера экрана и ориентации

    Созданные документы доступны в сети — немедленно

    Ваша документация сразу же доступна в сети, размещена на серверах Manula.com.

    Готов к размещению ссылок с вашего собственного веб-сайта и/или программного продукта.

    Мгновенная публикация изменений темы

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

    Нет необходимости загружать HTML-файлы и изображения. Изменения вступают в силу мгновенно.

    Документация автоматически адаптируется к любому размеру экрана, устройству и ориентации

    Дизайн ваших интерактивных документов автоматически адаптируется к размеру экрана ваших читателей.

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

    Встроенная сверхбыстрая поисковая система

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

    Автоматически загружаемые версии руководств в формате PDF

    Предложите своим читателям загружаемые PDF-документы. Файлы PDF могут быть обновлены в любое время из вашей тематической базы данных. Щелкните здесь, чтобы просмотреть пример руководства в формате PDF.

    Создание «Личных» документов (необязательно)

    По умолчанию ваша документация общедоступна в Интернете. Параметр «Частный» позволяет заблокировать публичный доступ к вашим документам, а затем предоставить доступ по имени пользователя и паролю только определенным пользователям.

    Отслеживание посещений документов и тем, оценок пользователей и комментариев к темам

    Автоматическая статистика просмотров документов и тем.

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

    «Это было полезно?» голосование за читателей.

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

    Разрешить читателям комментировать темы.

    Позвольте своим читателям оставлять отзывы по темам документации (необязательно). Модерируйте комментарии в теме, отвечайте на них. Чтобы избежать вопросов в службу поддержки, добавьте ссылку в форму поддержки или адрес электронной почты.

    Отслеживайте все поисковые запросы пользователей, чтобы найти ключевые слова.

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

    Свяжите свою учетную запись Google Analytics, чтобы получить дополнительную статистику.

    Нужна более подробная статистика по вашей онлайн-документации? Просто введите идентификатор Google Analytics для полного отслеживания Analytics.

    Блог Manula

    Последние сообщения

    • Сервер доставки изображений обновлен 28 февраля 2022 г.
    • Новая настройка открытия внешних ссылок (в новой вкладке или нет) 13 октября 2021 г.
    • Содержание оперативных руководств теперь «автопрокручивается» 19 августа 2021 г.
    • Добавлено: литовский перевод пользовательского интерфейса живых руководств 26 июля 2021 г.
    • Исправлено: поиск с кавычками в админке 25 июня 2021
    • Исправлено: некорректное отображение спецсимволов во вкладке браузера 23 июня 2021 г.
    • Исправлено: поиск с двойными кавычками 12 мая 2021
    • Оптимизировано запоминание состояния ToC 10 марта 2021 г.
    • Текущие руководства теперь включают атрибут lang=»xx» 2 марта 2021 г.
    • Поддержка Диспетчера тегов Google 25 февраля 2021 г.
    • Встраивание видео из Microsoft Stream Video 10 февраля 2021 г.
    • Улучшено качество изображения в сгенерированных PDF-файлах 26 января 2021 г.
    • Онлайн-руководства еще быстрее благодаря кэшированию 13 января 2021 г.
    • Ускоренный просмотр онлайн-руководств 23 декабря 2020 г.
    • Панель оглавления в редакторе теперь прокручивается отдельно 25 ноября 2020 г.
    • Текущие руководства теперь автоматически раскрывают темы в ToC 24 ноября 2020 г.