Документерра как альтернатива Confluence

В прошлом году мы начали сотрудничать с российской компанией «Документерра», которая создаёт одноименный инструмент для разработки и хранения технической документации и баз знаний, во многом схожий со всем известным решением Atlassian Confluence. Александр Муравьев, директор Документерры, подготовил материал, где рассказал о том, какие перспективы сейчас у Confluence на российском рынке, почему Документерру можно считать его альтернативой и как перейти с одного инструмента на другой.

Многие иностранные компании покидают российский рынок, что, с одной стороны, расстраивает, но с другой – открывает возможности отечественным компаниям проявить себя. Поскольку в IT-сфере уровень зависимости от импорта в отрасли цифровых продуктов очень высок и составляет около 90%, о замене на собственные аналоги задумались даже на государственном уровне. Именно поэтому российская экономика взяла курс на импортозамещение и поддержку местных производителей, товары которых могут стать достойными конкурентами западных разработок.

2 марта 2022 года компания Atlassian сообщила, что приостановит продажу всех новых продуктов в России. 15 февраля 2023 года, компания перестала продавать новые приложения для существующих лицензий Server. А с 15 февраля 2024 года техническая поддержка продуктов Atlassian Server прекратится. И это создает определенные проблемы.
Если вы уже давно работаете с технической документацией в системе Confluence и боитесь потерять весь свой контент, у нас есть хорошая замена – платформа Документерра. Наши партнеры из компании ПроТекст предоставили замечательную возможность рассказать про это решение. Как и Confluence, Документерра является системой создания и хранения баз знаний и разного рода документации. Поэтому мы решили поделиться своим взглядом и сделать, насколько это возможно, объективное сравнение Confluence и Документерры.

Написание контента

Форматирование

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

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

То есть платформа имеет жесткие ограничения. И иногда, чтобы сделать простую с виду вещь, придется потратить много времени.

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

• Форматировать таблицы произвольным образом, включая размер, цвет, стиль и т.д.
• Вставлять графические элементы (картинки, видео, Gif-анимации). При этом настройка внешнего вида интерфейса читателя тоже гибкая.
• Вставлять примеры кода, информационные поля, раскрываемые блоки, всплывающие надписи.
• Использовать любые шрифты, свои собственные шрифты, при необходимости подключать сторонние платные шрифты.
• Добавлять собственные типовые элементы для вставки (экспресс-блоки: раскрываемое поле, инфобокс, предупреждение).
• Редактировать контент в режиме исходного HTML кода.
• Вставлять якорные ссылки.
• Вставлять диаграммы, созданные в сторонних сервисах (Draw.io, Lucidchart и другие).

Шаблоны

Кроме того, в обеих системах есть понятие шаблонов. В Confluence для создания шаблона необходимо создать структуру страницы, скопировать ее и добавить название шаблона (wiki-разметка структуры страницы). Понятие шаблонов в Документерре выглядит по-другому. При создании нового документа можно выбрать источник для копирования. Это и есть функция шаблонов. Сначала создайте набор топиков-шаблонов, а потом при создании нового топика выберите, какой взять за основу.

Единый источник

Концепция единого источника помогает избежать дублирования при работе с документами, позволяя осуществлять многократное повторное использование существующего контента. Это очень повышает производительность совместной работы.  В Confluence для применения этой технологии используются специальные плагины типа «Scroll Versions for Confluence». В Документерре встроена поддержка этой технологии через использование Переменных и Условных Блоков – сторонних решений не требуется.

Командная работа

Общее

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

• Проект хранит набор документов в иерархическом виде.
• Его можно экспортировать.
• К проекту можно настраивать доступ разного уровня.

То есть задача централизации информации в компании вполне решается при помощи Документерры.

Особенности Документерры

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

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

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

Уведомления

В Confluence участники команды получают уведомления, когда вы отмечаете их тегом, чтобы держать в курсе прогресса, или назначаете задание. В Документерре уведомления о назначении задач и изменении в документах приходят по почте, так же как и в Confluence. Хотя некоторые пользователи находят это неудобным: “Сложно следить за изменениями, куча уведомлений прилетают в почту и превращаются в спам”. Мы рекомендуем использовать фильтры в почте, чтобы складывать уведомления от Документерры в отдельную папку и просматривать их по мере надобности. Кроме того, в Документерре можно управлять тем, какие уведомления вы получаете – соответствующие настройки есть в профиле пользователя.

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

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

Предоставление доступа

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

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

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

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

* Автор. Используется для сотрудников – такие учётные записи могут иметь разные роли и права. Например, какой-то сотрудник может быть администратором системы, а другой сотрудник – только создавать контент. Также можно создать учетную запись с доступом к просмотру и комментированию проектов и публикаций, но менять контент нельзя. Это полезно, например, чтобы дать доступ программисту на ревью для добавления комментариев, но без возможности менять сам текст. Плюс можно настраивать доступ к конкретным проектам каждому сотруднику.

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

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

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

История версий

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

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

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

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

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

Публикация и экспорт документации

Если вам нужно опубликовать сразу большой объем материалов, то Confluence – не лучший выбор. Придется публиковать по одной странице, а это неудобно. Например, при релизе новой версии ПО надо обновлять тысячи топиков сразу. В Документерре для такой ситуации есть процесс публикации выбранных топиков. Можно также выпустить несколько версий справки и дать возможность читателям переключаться между ними. То есть легко публиковать документы как все вместе (например, тысячи топиков сразу) так и по одному-два топика.

Переводы

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

В Документерре существует целая внутренняя экосистема для перевода документации:

• Редактор переводов. Документ для перевода автоматически разбивается на сегменты и отображается в табличном виде «источник-перевод».
• Специальная роль для переводчиков. Благодаря этому они могут редактировать только текст перевода и никак не могут повлиять на оригинал.
• Автоматическая синхронизация из оригинала в перевод, если вы вносите изменения в исходный документ.
• Поддержка машинного перевода через Google Cloud Translation и Microsoft Translator.
• Поддержка импорта/экспорта *.XLIFF файлов для работы как с внешними переводчиками, так и со сторонними системами переводов.

API

API в инструментах документации – иногда очень полезная функция для автоматизации разных процессов и для интеграции с другими системами. И у Документерры, и у Confluence есть API. С помощью API Документерры можно управлять пользователями (создавать, менять, отключать), получать контент топиков, производить поиск и так далее. На практике это применяется для:

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

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

Интеграции

Существует маркетплейс с интеграциями и плагинами для Confluence. Там есть платные и бесплатные дополнения. С одной стороны, это удобно. С другой – люди часто жалуются, что при обновлении версии Confluence часть из них перестаёт работать. К тому же серверная версия Confluence скоро перестанет работать, а в облачной версии будут доступны далеко не все плагины. Две стороны одной медали.

В Документерре нет маркетплейса, но есть ряд наиболее полезных интеграций: Google Analytics, ZenDesk, AddThis, Azure AD, Bing, Google Translate, Gravatar, LiveChat, Salesforce и другие. Как правило, в нашей платформе интеграции с внешними сервисами происходят на основе JavaScript библиотек или кода для встраивания (embed code).

Управление задачами

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

В Документерре на данный момент нет интеграции с Jira, хотя она есть в планах, как и поддержка похожих систем, таких как Trello и Яндекс Трекер. Кроме того, в Документерре уже есть внутренняя функция управления задачами по документации – для каждого топика можно создать внутренние задачи, видеть количество невыполненных задач, помечать задачи как выполненные, получать уведомления о добавлении или изменении задач. Кроме того, сами топики имеют статусы и ответственных, поэтому, в какой-то мере, являются задачами – по статусам топиков есть отчёты, фильтры, графики.

Поиск

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

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

В Документерре все логично и быстро:

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

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

Миграция

Представьте, у вас уже есть какая-то документация, которую вы создавали в Confluence годами. И вот возникает задача замены системы. Есть ли способ перенести эти сотни, а то и тысячи документов легко и быстро на другую платформу?

В идеале у нового инструмента, куда вы мигрируете, должен быть API для автоматизации прямого переноса. При переносе через экспорт-импорт в формате HTML все макросы Confluence превратятся в статический контент, а дерево документов может потеряться. При таком сценарии, кажется, куда проще “скопировать и вставить”, чем выполнять манипуляции с выгрузкой, загрузкой и последующим форматированием.

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

Кроме переноса контента из Confluence по API, вы можете импортировать файлы из популярных форматов:

• Microsoft Word
• Google Docs
• CHM
• HTML
• и другие.

Месторасположение компании

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

Наша команда Документерры имеет значительный опыт работы в области облачных решений. Благодаря этому мы сформировали надежную и квалифицированную команду, а также базу клиентов из разных отраслей. Мы постоянно совершенствуемся: прошли акселерацию по программе GoGlobal от ФРИИ в 2021 году, имеем аккредитацию Министерства цифрового развития, связи и массовых коммуникаций РФ как IT-компания.

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

Заключение

Четверть российских компаний использует облачные сервисы. Наш мир постоянно меняется, и поэтому важно быть готовыми к возможным переменам и стараться минимизировать риски отключения необходимых для работы сервисов. Для профессиональных команд, которым нужна эффективная совместная работа и полная интеграция, Документерра станет отличной альтернативой Confluence. Она изначально позиционировалась, как инструмент создания онлайн документации для технических писателей, что отражается на результате. Когда речь заходит о функции внутренней вики, то по некоторым параметрам Документерра не дотягивает до Confluence, но мы будем работать над этим. А пока Документерра уже отлично решает часть задач, и будучи российским продуктом позволяет заменить Confluence быстро и без потери данных! И напоследок для удобства сравнения приведём основные функции и особенности обоих инструментов в сводной таблице:

Если вас заинтересовала платформа Документерра и вы хотите увидеть её в действии, запишитесь на бесплатную онлайн-демонстрацию, где вы сможете получить ответы на все свои вопросы:

А если вы хотите получить скидку 3% на приобретение лицензии – просто заполните эту форму:

Тэги: Confluence, Документерра, инструменты