Как использовать макросы для систематизации документов «как в Confluence»?
Привет! Приятно ведь читать хорошо оформленные статьи на уютном хабре? В которых часть текста спрятана под катом, есть подписи к картинкам, красивые и понятные таблицы и все остальные плюшки? Я думаю очень приятно. Поэтому предлагаю рассмотреть немного полезных советов, о том какие макросы в Confluence помогали делать это раньше, а теперь точно также помогают в EvaWiki.
В интернете много полезной информации по использованию Confluence. Например, вот статья с рекомендациями по использованию макросов. В ней всё достаточно круто описано, но хотелось бы внести поправку. Конфлюенс ушел из России, а EvaWiki осталась. И теперь тот функционал, который был в зарубежном решении можно использовать в российском.
Статья может быть полезной для тех, кто активно работал в Confluence и хочет точно также делать это в нашем ПО.
Позволю себе историческую справку на полминуты ©
В 2022-м году с российского рынка ушла компания Atlassian. Российский бизнес использовал ее продукты годами, поэтому уход с рынка был драматичен. Какое-то время можно было работать по старым лицензиям, но было неясно, что же делать дальше? Для команды EvaTeam все было очевидно — надо было разработать свои продукты, аналогичные тому, что было у Atlassian.
Мы исходили из того, чтобы при переходе на новый продукт не терялся бы и бит данных, а сам продукт-аналог был бы таким, чтобы переход на него был простым и быстрым. Таким продуктом стала EvaWiki: это аналог Confluence, с бесшовным переходом: вы просто копируете данные, выходите из Confluence, загружаете данные в EvaWiki и начинаете работать.
И если вы пользовались какими-то настройками или макросами в Confluence, то без труда найдете их в EvaWiki. Я докажу это ниже.
Макросы: зачем нужны и как работают в Confluence
Макросы существенно расширяют возможности работы с текстами и документами — помогают настроить навигацию в системе знаний, создать единый подход к оформлению документов определенных типов. Макросы обеспечивают загрузку контента извне или настройку «красивостей» вроде ярких вставок, цветных цитат и проч.
Как и в Confluence, в EvaWiki есть привычные большинству пользователей cочетания клавиш, а также типичная навигация, начиная от тулбара и шорткатов, и заканчивая MagicKey (косой чертой). Визуально работа с документами выглядит простой и интуитивно-понятной.
При работе через magic key, с помощью слэша, можно вызвать дополнительное меню и в любую точку/строку документа «воткнуть» нужный контент в нужном виде. Всё специально сделано знакомо пользователям Confluence. Видя привычные способы обращения к макросам, они успокаиваются и через 10 минут работают в EvaWiki так, будто были здесь всегда.
В продуктах Atlassian есть десятки встроенных макросов и ещё больше тысячи сторонних. Но обычно даже очень продвинутым пользователям требуется где-то 20–30. А если уж говорить про самые используемые и популярные, то их наберется максимум дюжина. Но они должны быть самыми-самыми — наглядными, простыми и удобными.
Оглавление
Первый по популярности в упорядочивании данных — макрос автоматического формирования оглавления. Не надо «ползать» по всему документу, а можно сразу обратиться к нужному блоку.
Ссылки формируются по заголовкам и сразу становятся активными.
Макеты
Второй по востребованности макрос — «Макеты», нужный для любого, кто стремится правильно и красиво оформить документ. Как минимум — разбить его на блоки или колонки, чтобы систематизировать контент и упростить его восприятие.
Инфопанели и цитаты
Как и у Confluence, у нас есть макрос «Инфопанели» — с его помощью можно подсветить и визуально выделить нужные участки текста. Правда, у EvaWiki набор таких врезок побольше, чем у базовой версии Confluence — 6, а не 4: чтобы, как говорится, «цветовая дифференциация штанов» (т.е. важных фрагментов контента) была на любой вкус.
Например, вводите /заметка, /информация, /готово, /важно, /ошибка или /предупреждение — и добавляйте нужный вам элемент.
Подчеркните цитату, добавив вертикальную черту на ее левом поле и настроив цвет шрифта. Введите /цитата, чтобы быстро добавить ее в свой контент.
Таблицы
Без ложной скромности скажу, что функционал работы с таблицами у EvaWiki такой, какой не найдешь в большинстве подобных продуктов. С помощью не только макросов, но разнообразных настроек, здесь можно играть с таблицами как угодно! Добавлять, убирать колонки или строки, автоматически формировать заголовки, в один клик (через плюсики) вызывать и настраивать дополнительные опции и т.д. Можно группировать ячейки, задавать цвета, настраивать типовое выравнивание и прочее — такая широта функционала доступна, пожалуй, лишь здесь и в экселе.
Вложения
На 5-е место по популярности мной поставлен макрос «Вложения» — он позволяет отразить все вложения, которые когда-либо были добавлены в документ. Их можно вывести на страницу для просмотра или скачать одним архивом. А также, используя функционал вложений к документу, можно в дальнейшем ссылаться на эти вложения при добавлении других макросов, без необходимости загружать их повторно. Очень удобно.
Include (Выборка)
Следующий макрос называется «Вставки» или «Инклюды» — он позволяет буквально собрать новый документ, как пазл, из нужных кусков других документов. Это крайне важная штука для компаний с разветвленным или сложным документооборотом, когда какие-то ключевые документы часто цитируются в других.
Создаём выборку в Документе 1
Выбираем и вставляем в Документе 2
Данный функционал помогает не только легко «копипастить» важную информацию (это было бы слишком просто), но и легко вносить изменения в огромный массив бумаг! Так, если в «родительском» документе меняется какая-то часть контента, то во всем бесконечно огромном числе «дочерних» документов этот контент также обновится — автоматически.
«Кат» (Expand)
А как же любимый многими «кат», который позволяет скрыть огромные уходящие вниз рулоны текста, спросит кто-то? Есть и такой макрос, «Экспанд» — настройка свертывания/развертывания контента. О том, насколько это удобно, и говорить нечего.
Вставка Word/Excel
EvaWiki позволяет не просто работать с контентом, но и «вгрузить» на нужную страницу любой Word- или Excel-документ. Суперфишка макроса Office Word/Excel — в том, что он грузится не в режиме импорта, а непосредственно вставляется в файл со всеми настройками и исходным форматированием. А вы можете что-то в этом файле менять как вам хочется, и версионность вложений обеспечит автоматическое обновление всех документов, где есть этот файл.
Статус
Любителям ярких визуальных акцентов понравится макрос «Статус», с помощью которого можно в документ «тиснуть» важную цитату в цветной врезке или облачке-баббле. Это не просто красиво, но и важно для выделения в больших серьезных текстах каких-то важных смыслов или нюансов.
Отображение дерева страниц и дочерних
Есть два очень удобных и функционально схожих макроса — «Отображение дерева страниц» и «Отображение дочерних». Первый позволяет нам указывать, от какого документа в обороте по определенной теме мы будем получать структуру, и задать для нее глубину иерархии. Прямо в документе будет выстраиваться структура взаимосвязей — подобно оглавлению, но только по источникам или структурам документов.
Второй макрос работает по такому же принципу, только строит «ветки» дочерних документов от текущего (того, в котором мы работаем). Вы можете в любой момент видеть, грубо говоря, что из чего растет!
Реестр связи
А вот чего в базовом Confluence не было (по крайней мере, на 2022-й год) — макроса «Реестр связи». Эта мощная штука позволяет составлять списки ссылок, чтобы наглядно видеть, какие документы на что ссылаются. Зачем это нужно?
В больших, разветвленных структурах или компаниях с долгой историей порой не разобраться в системе бюрократической взаимосвязи. Выстроить эту связь между документами, понять, «какой док на какой док ссылается», и позволяет данный макрос. Кроме того, для каждого файла указывается тип связи (исходящая или входящая), что поможет частично устанавливать историю и иерархию различных документов. При этом реестр можно построить не только по документам, но и по задачам, с которыми установлены связи.
https://docs.evateam.ru/files/obj/CmfDocument/CmfDocument%3A73c/CmfDocument%3A73c35608–5ed0–11ee-b663–00161e12fc1e/ezgif-1–865bb8c240.gif? version=1
Порой это очень важно. Например, вам кажется, что какой-то старый протокол/приказ/гайд никто не читает и он не имеет смысла. Вы можете проверить его реестр связи — и вдруг выяснить, что без этого файла не работают какие-то более актуальные документы. А иногда можно найти и документы, которые никак и ни с какими иными файлами не связаны — и соответственно решить, насколько они нужны компании.
Плагины
Отдельно стоит сказать что в EvaWiki реализованы не только стандартные макросы Confluence, но и популярные плагины. И если в старом решении их нужно отдельно докупать на маркетплейсе, то здесь их функционал уже работает «из коробки». Это, например, плагины draw.io, PlantUML, Comala Document Management и другие.
Это не весь список реализованных макросов, а только самые популярные, которые раньше использовались в Confluence, а теперь можно также использовать в EvaWiki.
Расскажите, какие макросы у вас «самые любимые» или какие вы используете чаще других? Возможно (но маловероятно))) это макросы из каких-то других систем, которых вам не хватало раньше и в Confluence?
