Confluence руководство пользователя на русском

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

• небольшая стоимость для организаций с численностью до 10 человек;
• наличие облачной и серверной версии;
• поддержка версионирования документов;
• комментирование документов (в том числе инлайн комментарии);
• удобный визуальный редактор;
• огромное количество плагинов и макросов, улучшающих работу с базой знаний;
• интеграция с Jira и Hip Chat.

Время на прочтение
8 мин

Количество просмотров 72K

Всем привет!

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

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

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

Инструменты

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

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

Макросы

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

Интерфейс работы с макросами максимально прост. Чтобы добавить макрос, надо нажать на плюс и выбрать нужный элемент из списка.

Если макрос самодостаточный, то есть не требует вставки чего-то еще внутри себя, — он выглядит как блок.

Если для работы макроса нужно что-то поместить внутрь него, он выглядит как рамка.

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

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

Шаблоны

Помимо макросов есть удобный инструмент предзаполнения контента — это шаблон.
Шаблоны можно использовать при создании любой страницы: просто нажать на три точки рядом с кнопкой «Создать» и выбрать нужный шаблон.

Тогда в созданную страницу добавится весь контент, который есть в шаблоне.

Создавать страницы из шаблонов может кто угодно, а вот создавать или редактировать сами шаблоны — только те, у кого есть на это права. В шаблон можно добавить дополнительные инструкции о том, как следует вести страницу.

Магия таблиц

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

Но даже такую замечательную сущность, как таблица, можно испортить. А можно удачно использовать и даже улучшить. Об этом ниже.

Фильтрация (платный плагин)

Любую огромную нечитаемую таблицу можно сделать чуть менее огромной и чуть более читаемой с помощью фильтрации. Для этого можно использовать платный макрос «Фильтр таблиц».

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

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

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

Сортировка (платный плагин)

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

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

Сводные таблицы (платный плагин)

Теперь перейдем к кейсу поинтереснее. Представьте, что ваша таблица огромная и надо что-то посчитать по ней. Конечно, можно скопировать ее в Excel, посчитать нужное и выгрузить данные назад в Confluence. А можно один раз применить макрос «Сводная таблица» и получить тот же результат, только еще и обновляемый.

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

Естественно, группировать можно по нескольким признакам сразу, все возможности можно посмотреть в документации.

Диаграммы (платный плагин)

Как я уже говорила, не все любят таблицы так сильно, как я. К сожалению, менеджеры в большинстве своем их вообще не любят. Зато все очень любят яркие цветные диаграммы.
Создатели Confluence об этом, безусловно, знали (наверняка у них тоже есть начальство, которое любит отчеты и диаграммы, куда же без него). Поэтому можно воспользоваться волшебным макросом «Диаграмма из таблицы». В этот макрос нужно положить сводную таблицу из предыдущего пункта, и вуаля — ваши серые скучные данные красиво визуализированы.

Естественно, в этом макросе тоже есть настройки. Ссылку на документацию к любому макросу можно найти в режиме редактирования этого макроса.

Простота агрегации

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

Метки

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

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

Свойства страниц

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

Обратите внимание на ID — его удобно задавать, чтобы навешивать разные группы свойств на разные страницы (или даже разные группы свойств на одну страницу).

Отчеты

По меткам можно собирать отчеты. Например, макрос «Отчет о содержимом» собирает все страницы с определенным набором меток.

Но более интересный отчет — это макрос «Отчет по свойствам страницы». Он тоже собирает все страницы с определенным набором меток, но не просто выводит их список, а составляет таблицу (улавливаете связь с началом статьи?), в которой столбцы — это ключи свойств страницы.

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

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

Например, у вас есть множество страниц сотрудников, у этих страниц есть набор свойств про человека: какого он уровня, где находится, когда пришел в команду и так далее. Это свойства отмечены ID = employee_inf. И есть второй набор свойств на этой же странице, в котором собрана информация о человеке, как о части команды: какую роль человек выполняет, в какой команде находится и так далее. Эти свойства отмечены ID = team_inf. Тогда при сборке отчета вы можете вывести только информацию по одному айдишнику или сразу по двум — как удобнее.

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

Итоговый процесс

Инструкция

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

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

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

Тогда итоговый процесс будет выглядеть так:

1. Вы создаете шаблон для информации определенного типа.
2. В этот шаблон добавляете метки и свойства страницы в макросе.
3. В любом удобном месте создаете корневую страницу с кнопкой, по клику на которую создается дочерняя страница из шаблона.
4. Пускаете на корневую страницу пользователей, которые потенциально будут генерировать нужную информацию (по нужному шаблону, нажимая на кнопку).
5. Собираете себе отчет по свойствам страницы через метки, которые вы указали в шаблоне.
6. Радуетесь: у вас есть вся нужная информация в удобном формате.

Подводные камни

Как инженер по качеству, я смело могу утверждать, что ничего идеального в мире нет. Даже божественные таблицу неидеальны. И в приведенном выше процессе есть подводные камни.

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

Пример хранения непродуктовой документации

Через описанный выше процесс можно организовать хранение почти любой информации. Прелесть подхода в том, что он универсальный: когда пользователи к нему привыкают, они перестают генерировать бардак. Также большой (но не бесплатный) плюс — возможность собирать на лету разнообразную статистику и рисовать по ней красивые диаграммы.

Приведу пример нашего процесса ведения информации о команде.

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

Как видите, у нас развернутая таблица свойств и сразу есть инструкции о том, как именно вести данную страницу. Часть тегов проставляют сами сотрудники по инструкциям, в шаблоне только основные: тег карточки employee-card, тег направления direction-involve и тег команды team-qa.

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

По тегам можно увидеть разные сводки, например по qa-upgrade-plan отобразатся все задания на развитие QA. При этом каждый человек в своей карточке сотрудника ведет важную историю и свой план развития — создает вложенную страницу из шаблона планов развития.

Заключение

Ведите любую документацию так, чтобы за нее не было стыдно, а пользователям не было мучительно больно!

Очень надеюсь, что статья будет полезна и во всех документациях мира наступит порядок.

Отправьте статью себе на почту

Хочу сразу предупредить — все нижесказанное относится к облачной версии Confluence 1000.0.0-3a7db14 (август 2017). Внешний вид может измениться, но в любом случае все эти возможности останутся. Просто кнопочка будет не слева, а сверху, или наоборот.

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

Вы также можете посмотреть обучающее видео. Удачи в освоении! 

Ссылка на Youtube.
Ссылка на ту же статью, но в конфлюенсе (там есть Table of Content, удобненько).

1. Создание и редактирование страницы. Create & edit page

1.1. Создание

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

Выбираем «blank page» — создать пустую страницу. Нажимаем Create

Заполняем ее — в Page Title указываем заголовок, а все, что ниже — сама страница. После заполнения нажимаем «опубликовать» справа снизу

Например, как-то так

1.2. Редактирование

Чтобы отредактировать страницу, нажмите на карандашик в верхней панели. Если карандашика нет — редактирование запрещено

2. Перемещение. Смена Location

2.1. При создании

Если мы ошиблись и хотели создать страницу в другом разделе — без паники. Не надо закрыть эту и создавать новую. Просто нажмите сверху на кнопку Location (кнопка доступна только при создании)

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

Выбираем из выпадающего списка новую страницу. Проверяем внизу разделы «Откуда → Куда переместить» и нажимаем Move. Все, страница будет создана, где нам нужно!

2.2. После создания

Если страница уже создана и только тут мы все осознали… То нажимаем на многоточие справа сверху и выбираем Move

3. Таблицы. Table

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

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

    добавить строку выше
    добавить строку ниже
    удалить строку
    вырезать строку
    скопировать строку
    вставить (вставляется она выше строки, где стоит курсор)
    аналогично с колонками

Если нужно выделить строку — нажмите Heading Row. Удобно при оформлении списка из сотни проверок (в моем случае — автотестов), чтобы хоть как-то разбить на группы

Если нужно объединить ячейки, нажимаем Merge Cells

А еще я люблю выделение цветом. Можно выделить всю строку, а можно одну ячейку. Снять выделение — нижний правый квадратик раскраски

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

Выделить жирненьким, курсивом итд — все как в ворде!

5. Списки

Есть буллиты

• раз
• два

Есть нумерованные списки. Опять же, а-ля ворд, ничего сложного.

Можно написать список, выделить и нажать кнопочку на панели инструментов. А можно начать вводить:

    буллиты — * <пункт списка>
    нумерация — 1 <пункт списка>

Если вы хотели именно звездочку поставить, то нажмите Ctrl + Z (отмена действия), когда конфлюенс после пробела поставит автоматом буллит

6. Скриншоты

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

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

Можно добавить новые, удалить текущие, посмотреть, какие версии были итд

7. Ссылки

Чтобы добавить ссылку, выделите часть слова и нажмите на два звена цепи. Там есть разные варианты. Самый простой — Web Link, просто вставляете URL и все.

8. Children Display — показать дочерние страницы

Очень удобный макрос. Показывает список всех дочерних страниц, вот так

Чтобы добавить его, нажмите «+» → Other Macros

А там начните вводить название — Children Display

Даже если конфлюенс русифицирован, система подскажет макрос

Там есть и другие клевые макросы, поизучайте на досуге 

9. Кто менял страницу??

Под заголовком страницы указано, кто последний ее изменял и когда. Вот это «когда» — это ссылка

Открыв ее, видим, какие правки были внесены в последней версии + все предыдущие.

10. Восстановление на версию

Открыв историю страницы (см прошлый пункт), вы можете откатить любые изменения. Откройте любую версию и нажмите Restore this Version.

11. Экспорт в ворд

Многоточие справа сверху — экспорт в ворд / пдф

12. View in Hierarchy

Если нужно поменять страницы местами, то многоточие справа сверху — View in Hierarchy

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

13. Log out

Чтобы разлогиниться, нажмите на свою иконку слева снизу и выберите в меню log out

14. Рестрикшены — ограничение доступа

В режиме просмотра или редактирования можно повесить.

Если ограничений нет, мы видим серый открытый замочек на странице и подпись «ограничений нет»

Нажимаем на него и вешаем ограничения. На редактирование или просмотр. Как хотите ツ 

15. Мои спейсы

На главной странице вы видите список «мои спейсы».

Это для быстрого доступа. Когда в компании 100500 спейсов, а вам нужны часто только некоторые из них. Если войти в сам спейс, то там справа сверху будет кнопка «Добавить в мои спейсы», или, наоборот, «Удалить», если он уже добавлен.

PS: статья написана в помощь студентам моей Школы для начинающих тестировщиков, ибо они много работают в конфлюенсе. Заходите и вы ツ