Что такое конфлюенс в тестировании
Проектирование в Confluence
Меня зовут Маша, я работаю инженером по обеспечению качества в группе компаний Тинькофф. Работа QA предполагает множество коммуникаций с разными людьми из разных команд, а я к тому же была менеджером и лектором образовательных программ, поэтому моя карта коммуникаций была максимально широкой. И в какой-то момент я взорвалась: я поняла, что больше не могу, не могу, не могу заполнять адовые тонны нечитаемых таблиц и документов.
Наверняка каждый из вас представил себе сейчас то, о чем я говорю, и облился холодным потом: списки фамилий без алфавитного порядка, таблицы в сотни столбцов со съехавшей версткой, таблицы в тысячи строк, в которых нужно стирать свой палец об колесико мыши, чтобы посмотреть заголовок, тонны страниц непронумерованных инструкций, сотни пересылаемых друг другу писем с данными, которые надо проанализировать и систематизировать и запихнуть в такие же нечитаемые таблицы.
И вот, когда я немного остыла, я решила написать эту статью. Я расскажу о том, как можно нормально (даже порой удобно) вести разнообразную непродуктовую документацию. Надеюсь, что статья разлетится по сети и уровень адища в соседних с разработкой отделах хоть чуть-чуть снизится, а люди (и я в том числе) станут чуточку счастливее.
Инструменты
Продуктовая документация часто хранится рядом с кодом, и это хорошо. А непродуктовая документация обычно хранится где попало. Часто люди стараются переносить информацию из разных мест в Confluence, и мы не исключение. Так что весь дальнейший рассказ о нем.
Вообще Confluence — это продвинутый вики-движок. Он позволяет работать с данными в разных видах отображения: текст с форматированием, таблицы, разнообразные диаграммы. Это очень интересный и мощный инструмент, но если не уметь его готовить, то вы получите очередную свалку нечитаемых документов. Я научу вас готовить!
Макросы
Почти вся магия Confluence строится на макросах. Макросов очень много, и их можно комбинировать друг с другом. Они бывают платными и бесплатными, далее будут разные примеры макросов со ссылками на документацию для них.
Интерфейс работы с макросами максимально прост. Чтобы добавить макрос, надо нажать на плюс и выбрать нужный элемент из списка.
Если макрос самодостаточный, то есть не требует вставки чего-то еще внутри себя, — он выглядит как блок.
Если для работы макроса нужно что-то поместить внутрь него, он выглядит как рамка.
При этом можно помещать внутрь одной рамки сколько угодно других, лишь бы в вашей пирамиде была логика.
У каждого макроса есть предварительный просмотр: в нем сразу видно, правильно ли вы заполнили и настроили макрос.
Шаблоны
Помимо макросов есть удобный инструмент предзаполнения контента — это шаблон.
Шаблоны можно использовать при создании любой страницы: просто нажать на три точки рядом с кнопкой «Создать» и выбрать нужный шаблон.
Тогда в созданную страницу добавится весь контент, который есть в шаблоне.
Создавать страницы из шаблонов может кто угодно, а вот создавать или редактировать сами шаблоны — только те, у кого есть на это права. В шаблон можно добавить дополнительные инструкции о том, как следует вести страницу.
Магия таблиц
Вообще-то я, как технарь, нежно люблю таблицы и могу почти любую информацию в них завернуть (хотя это и не всегда эффективно). Сами по себе таблицы четкие, структурированные, масштабируемые, волшебные!
Но даже такую замечательную сущность, как таблица, можно испортить. А можно удачно использовать и даже улучшить. Об этом ниже.
Фильтрация (платный плагин)
Любую огромную нечитаемую таблицу можно сделать чуть менее огромной и чуть более читаемой с помощью фильтрации. Для этого можно использовать платный макрос «Фильтр таблиц».
Внутрь этого макроса надо засунуть таблицу (можно даже самую уродливую, главное — запихнуть ее целиком). В макросе можно выбрать столбцы для фильтра с выпадающим списком, текстового фильтра, числового и фильтра по датам.
Вот представьте, что всю информацию по кандидатам на все вакансии записывают табличным списком. Естественно, неотсортированным — люди же приходят на собеседования не по алфавиту. А вам надо понять, проводили ли вы собеседование с конкретным соискателем раньше. Надо просто засунуть этот ад в макрос фильтра, добавить текстовый фильтр по фамилии — и вуаля, информация у вас на экране.
Стоит отметить, что фильтрация огромных таблиц может влиять на работу системы и время загрузки страниц, поэтому засунуть огромную таблицу в фильтр — временный костыль, лучше выстроить процесс, в котором людям не приходится создавать огромные нечитаемые таблицы (пример процесса будет в конце статьи).
Сортировка (платный плагин)
С помощью волшебного макроса «Фильтр таблиц» также можно задать сортировку по умолчанию по любому столбцу и пронумеровать строки. Или нажать на любой столбец таблицы, засунутой в макрос фильтра, и произойдет сортировка по этому столбцу.
Например, у вас есть та же самая таблица с соискателями и надо прикинуть, сколько собеседований было проведено в определенный месяц, — сортируйте по дате и радуйтесь.
Сводные таблицы (платный плагин)
Теперь перейдем к кейсу поинтереснее. Представьте, что ваша таблица огромная и надо что-то посчитать по ней. Конечно, можно скопировать ее в Excel, посчитать нужное и выгрузить данные назад в Confluence. А можно один раз применить макрос «Сводная таблица» и получить тот же результат, только еще и обновляемый.
Например: у вас есть таблица, в которой собраны данные всех сотрудников — где они территориально находятся и какие должности занимают. Чтобы посчитать, сколько человек находится в каждом городе, вам нужно выбрать в макросе «Сводная таблица» строку, по которой агрегируются данные (местоположение) и тип операции (сложение).
Естественно, группировать можно по нескольким признакам сразу, все возможности можно посмотреть в документации.
Диаграммы (платный плагин)
Как я уже говорила, не все любят таблицы так сильно, как я. К сожалению, менеджеры в большинстве своем их вообще не любят. Зато все очень любят яркие цветные диаграммы.
Создатели Confluence об этом, безусловно, знали (наверняка у них тоже есть начальство, которое любит отчеты и диаграммы, куда же без него). Поэтому можно воспользоваться волшебным макросом «Диаграмма из таблицы». В этот макрос нужно положить сводную таблицу из предыдущего пункта, и вуаля — ваши серые скучные данные красиво визуализированы.
Естественно, в этом макросе тоже есть настройки. Ссылку на документацию к любому макросу можно найти в режиме редактирования этого макроса.
Простота агрегации
Информация из предыдущих пунктов наверняка не была для вас откровением. Но теперь вы точно умеете пользоваться макросами, а я могу перейти к более интересной части статьи.
Метки
Плохо, когда люди хранят информацию в одной неструктурированной статье или огромной таблице. Еще хуже — когда части этой информации не только нечитаемо оформлены, но и раскиданы по просторам Confluence. Благо есть возможность собрать раскиданную информацию в одном месте. Для этого надо воспользоваться метками (знакомыми всем по соцсетям тегами).
На любую страницу можно добавить любое количество меток. Если нажать на метку, вы попадете на страницу агрегации, где есть ссылки на все материалы с этой меткой, а также с набором связанных меток. Связанные метки — это те, которые часто встречаются на одной странице.
Свойства страниц
На страницу можно добавить еще один интересный макрос для структурирования информации — «Свойства страниц». Внутрь него нужно подать таблицу из двух столбцов, первый будет являться ключом, а второй — значением свойства. Причем макрос можно скрыть со страницы, чтобы он не мешал читать контент, но при этом страница все равно будет отмечена нужными ключами.
Обратите внимание на ID — его удобно задавать, чтобы навешивать разные группы свойств на разные страницы (или даже разные группы свойств на одну страницу).
Отчеты
По меткам можно собирать отчеты. Например, макрос «Отчет о содержимом» собирает все страницы с определенным набором меток.
Но более интересный отчет — это макрос «Отчет по свойствам страницы». Он тоже собирает все страницы с определенным набором меток, но не просто выводит их список, а составляет таблицу (улавливаете связь с началом статьи?), в которой столбцы — это ключи свойств страницы.
Получается сводная таблица по информации из разных источников. Приятно, что у нее есть удобные функции: адаптивная верстка, сортировка по любому столбцу. Также такую отчетную таблицу можно конфигурировать внутри макроса.
При конфигурировании можно убрать из отчета какие-то столбцы, задать состояние по умолчанию или количество отображаемых записей. А еще можно задать ID свойства страницы, чтобы видеть только нужную информацию.
Например, у вас есть множество страниц сотрудников, у этих страниц есть набор свойств про человека: какого он уровня, где находится, когда пришел в команду и так далее. Это свойства отмечены ID = employee_inf. И есть второй набор свойств на этой же странице, в котором собрана информация о человеке, как о части команды: какую роль человек выполняет, в какой команде находится и так далее. Эти свойства отмечены ID = team_inf. Тогда при сборке отчета вы можете вывести только информацию по одному айдишнику или сразу по двум — как удобнее.
Прелесть такого подхода в том, что каждый может собрать нужную для себя информационную таблицу, которая не будет ничего дублировать и будет обновляться при обновлении основной страницы. Например: тимлиду не важно, когда его разработчики устроились на работу, но важно, какую роль каждый из них выполняет в команде. Тимлид соберет себе отчет по команде. А бухгалтеру вообще все равно, кто какую роль выполняет, но важны должности — он соберет себе отчет по должностям. При этом источник информации не будет дублироваться или переноситься.
Итоговый процесс
Инструкция
Итак, мы можем красиво структурировать и эффективно агрегировать информацию в Confluence на примере использования макросов. Но в идеале нужно сделать так, чтобы новая информация сразу была структурированной и попадала во все уже используемые механизмы агрегации.
Тут на помощь придет связка макросов и шаблонов. Чтобы заставить людей создавать новые страницы в нужном формате, можно использовать макрос «Создать из шаблона». Он добавляет на страницу кнопку, по нажатию на которую создается новая страница из нужного вам шаблона. Таким образом вы заставляете людей сразу работать в нужном вам формате.
В шаблон, из которого вы даете создавать страницу, нужно заранее добавить метки, макрос «Свойства страницы» и таблицу нужных вам свойств. Также рекомендую добавить инструкции о том, какими значениями следует наполнять страницу, и значения свойств.
Тогда итоговый процесс будет выглядеть так:
Подводные камни
Как инженер по качеству, я смело могу утверждать, что ничего идеального в мире нет. Даже божественные таблицу неидеальны. И в приведенном выше процессе есть подводные камни.
Пример хранения непродуктовой документации
Через описанный выше процесс можно организовать хранение почти любой информации. Прелесть подхода в том, что он универсальный: когда пользователи к нему привыкают, они перестают генерировать бардак. Также большой (но не бесплатный) плюс — возможность собирать на лету разнообразную статистику и рисовать по ней красивые диаграммы.
Приведу пример нашего процесса ведения информации о команде.
Для каждого человека в команде мы решили создать карточку сотрудника. Соответственно, у нас есть шаблон, по которому каждый новый человек создает себе эту карточку и ведет в ней всю личную информацию.
Как видите, у нас развернутая таблица свойств и сразу есть инструкции о том, как именно вести данную страницу. Часть тегов проставляют сами сотрудники по инструкциям, в шаблоне только основные: тег карточки employee-card, тег направления direction-involve и тег команды team-qa.
В итоге после того, как каждый создал себе карточку, получается полная таблица с информацией по сотрудникам. Эту информацию можно использовать в разных точках. Ресурсные менеджеры могут собрать себе общие таблицы, а лиды команд — командные таблицы, добавляя в выборку тег команды.
По тегам можно увидеть разные сводки, например по qa-upgrade-plan отобразатся все задания на развитие QA. При этом каждый человек в своей карточке сотрудника ведет важную историю и свой план развития — создает вложенную страницу из шаблона планов развития.
Заключение
Ведите любую документацию так, чтобы за нее не было стыдно, а пользователям не было мучительно больно!
Очень надеюсь, что статья будет полезна и во всех документациях мира наступит порядок.
Рекомендации по работе с Confluence
Командам нравится Confluence, потому что этот гибкий инструмент можно легко адаптировать к любой организации. Чтобы помочь вам сориентироваться во множестве способов эффективного использования Confluence, мы подготовили набор рекомендаций.
Прежде чем начать знакомство с материалом, зарегистрируйтесь на бесплатном сайте Confluence Cloud и прочтите следующие разделы: «Настройка сайта и разделов», «Создание контента в Confluence» и «Навигация в Confluence».
Создание привлекательного контента
Вы напряженно трудитесь и хотите, чтобы созданный контент соответствовал приложенным усилиям. Эти ресурсы помогут создать именно такой, прекрасный и привлекательный контент.
Создавайте прекрасные страницы в Confluence
В этом четырехминутном видео показано, как в Confluence можно создать страницу с чистого листа или с помощью рекомендованных шаблонов. Представленные здесь методы помогут создавать в Confluence прекрасные страницы, которые будут выделяться на общем фоне.
Форматирование страницы
Узнайте, как с помощью редактора Confluence Cloud отформатировать текст, изменить макет страницы, добавить таблицы, мультимедийные данные и ссылки на контент.
Начните с шаблона страницы
Confluence можно использовать для представления самой разнообразной информации: протоколов собраний, планов проектов, руководств по адаптации новых сотрудников и многого другого. Шаблоны страниц дадут мощный импульс вашему следующему проекту благодаря заложенному в них профильному опыту.
Cloud / Data Center / Server
Создайте собственный настраиваемый шаблон
Шаблоны страниц помогают сохранить единообразие в пределах команды или организации. Из этой записи в блоге вы узнаете, как можно использовать функциональные возможности Confluence для совершенствования шаблонов.
Поддерживайте порядок
По мере того как команда растет и все больше людей начинают использовать Confluence для обмена информацией, проблема поддержания порядка становится все более острой. Используйте эти ресурсы для создания и поддержания эффективной стратегии упорядочения контента своей команды.
Cloud / Data Center / Server
Создание масштабируемой информационной архитектуры
Узнайте, как сгруппировать контент, используя информационную архитектуру, учитывающую текущие и будущие потребности организации.
Cloud / Data Center / Server
Поддерживайте порядок на своем сайте как Мари Кондо
Выполните эти четыре шага, чтобы стать Мари Кондо в Confluence. Из этой записи в блоге вы узнаете, как найти на сайте место для каждой страницы, поддерживать порядок на сайте и избавляться от устаревшего контента.
Как внедрить Atlassian Jira + Confluence в корпорации. Технические вопросы
Планируете внедрение ПО Atlassian (Jira, Confluence)? Не хотите допустить жестоких ошибок в проектировании, которые потом придётся решать в последний момент?
Тогда вам сюда — рассматриваем внедрение Atlassian Jira + Confluence в корпорации с учётом различных технических аспектов.
Здравствуйте, я являюсь руководителем центра компетенции по продуктам Atlassian в РСХБ (Россельхозбанк) и отвечаю за развитие Системы управления жизненным циклом (СУЖЦ) построенной на программных продуктах Jira и Confluence.
В этой статье опишу технические аспекты построения СУЖЦ. Статья будет полезна всем, кто планирует к внедрению или занимается развитием систем построенных на ПО Atlassian в корпоративном окружении. Статья не требует специальных знаний и рассчитана на начальный уровень знакомства с продуктами компании Atlassian. Статья будет полезна администраторам, владельцам продукта, руководителям проектов, архитекторам, всем кто планирует внедрение систем на основе ПО Atlassian.
Введение
В статье будут рассмотрены технические вопросы внедрения Системы управления жизненным циклом (СУЖЦ) в корпоративном окружении. Давайте вначале определим, что же это значит.
А что значит корпоративное решение?
Это значит решение:
А что такое Система управление жизненным циклом (СУЖЦ)?
Если коротко, то в нашем случае это Atlassian Jira и Atlassian Confluence — система предоставляющая инструментарий для организации коллективной работы. Система не «навязывает» правила организации работы, а предоставляет разнообразный инструментарий для работы, это и Scrum, и Kanban-доски, и водопадная модель, и масштабируемый Scrum и т.д.
Название СУЖЦ не является отраслевым термином или общеупотребительным понятием, это просто название системы в нашем Банке. СУЖЦ для нас не является системой баг-трэккинга, не является системой Управления инцидентами и системой Управления изменениями.
В системе конечно же присутствует функционал и для баг-трэккинга, и для регистрации инцидентов, и для управления изменениями. И для тех или иных задач этот функционал используется. Но нельзя сказать, что все баги или все инциденты или все изменения регистрируется в нашей системе. В каждом конкретном случае своя специфика. Если какое-то подразделение использует Jira и ведёт там изменение, то для данного изменения, данная команда может решить вести там все баги, все изменения, все инциденты. Но это локальное решение одной отдельной команды, для одной конкретной задачи.
Что в себя включает внедрение?
Внедрение решения состоит из множества технических и организационных вопросов:
Особенности Atlassian
Компания Atlassian является лидером во многих сегментах:
Продукты компании Atlassian обладают всеми необходимыми корпоративными функциями. Я отмечу следующие особенности:
Техническая архитектура
Лицензирование
Вопросы лицензирования Atlassian заслуживают отдельной статьи, тут упомяну только общие принципы.
Главные вопросы с которыми мы встретились — это вопросы лицензирования редакций Data Center. Особенности лицензирования для редакций Server и Data Center:
Функциональный объём внедрения
Базовая поставка ПО Atlassian включает огромное количество возможностей, но зачастую возможностей, предоставляемых системой сильно не хватает. Иногда даже простейшие функции недоступны в базовой поставке, поэтому без плагинов не обойтись практически при любом внедрении. При этом важно понимать, Jira — это платформа, здесь можно запрограммировать любой функционал и плагины — это платная реализация дополнительного функционала. Для системы Jira мы используем следующие плагины (картинка кликабельна): 
Для системы Confluence мы используем следующие плагины (картинка кликабельна): 
Комментарии к таблицам с плагинами:
Заключение
Итак, мы рассмотрели технические особенности внедрения системы на основе продуктов Atlassian. Предложенное решение представляет собой одно из возможных решений и хорошо подходит для корпоративного окружения
Предложенное решение — масштабируемое, отказоустойчивое, сдержит три среды для организации разработки и тестирования, содержит все необходимые элементы для совместной работы в системе и предоставляет широкий спектр инструментов для управления проектами.
С радостью отвечу на вопросы в комментариях.
Основы работы в Confluence
О Confluence
Создавайте контент, сотрудничайте и организуйте всю рабочую информацию в одном месте. Confluence — это пространство для команд, в котором накопленные знания объединены с возможностями для совместной работы. Динамические страницы представляют собой площадку для творчества, сбора информации и совместной работы участников команды над любыми проектами и идеями. Благодаря разделам можно структурировать и организовывать работу в команде, а также предоставлять общий доступ к базе знаний организации и к информации, необходимой участникам для эффективной работы. Подробнее о возможностях Confluence.
Confluence могут использовать команды любого размера и типа — как те, которые занимаются крупными, критически важными проектами и должны строго следовать рекомендациям, так и те, которые ищут пространство для формирования командной культуры и более открытого и естественного способа взаимодействия друг с другом.
Вооружившись Confluence, команда сможет быстро принимать решения, добиться согласованности и достичь больших результатов при совместной работе.
Варианты размещения
Confluence может работать в облаке, в вашей собственной инфраструктуре или в большом масштабе. Изучите предложенные далее варианты размещения и определите, какой из них лучше всего подходит вашей организации.
Cloud
В варианте Confluence Cloud мы разместим сайт за вас: никаких серверов, хранилищ или технического обслуживания не потребуется. Вы получите мгновенный доступ к новейшим возможностям с автоматическим обновлением, оптимальной производительностью и эластичным масштабированием благодаря размещению в облаке AWS.
Data Center
Confluence Data Center — это решение для самостоятельного управления с разными вариантами конфигурации, которые позволят выстроить командную работу с учетом потребностей организации. Режим «Только чтение» и гибкость развертывания с привлечением поставщиков IaaS (таких как AWS и Azure) обеспечат бесперебойный доступ и масштабирование с учетом потребностей ваших пользователей.
Server
При выборе варианта Confluence Server вы размещаете Confluence на собственном оборудовании и можете настраивать параметры установки по своему усмотрению. Этот вариант подходит командам, которые хотят контролировать все детали, установить более жесткие требования к управлению данными и готовы к любым сложностям, связанным с самостоятельным размещением.
Для варианта Confluence Cloud мы предлагаем тарифные планы Free, Standard и Premium, рассчитанные на команды с разными потребностями. Подробнее о планах подписки на Confluence Cloud см. в этом обзоре.
Основные термины
Страница
Контент размещается на страницах — динамических документах, которые вы создаете на сайте Confluence. Страницы могут содержать любую информацию: от планов проектов до протоколов собраний, от руководств по поиску и устранению неисправностей до политик и многого другого. Вместе с Confluence поставляются шаблоны, которые помогают создавать прекрасные страницы для любого контента. Если не удастся найти шаблон для нужного типа контента, всегда можно начать с чистого листа.
Раздел
Страницы хранятся в разделах — рабочих пространствах, предназначенных для совместной работы и упорядочения контента. Связанный контент лучше размещать в одном разделе, но вы можете создать столько разделов, сколько требуется команде. Например, одна маркетинговая команда может хранить всю работу в одном разделе, выделив на каждую маркетинговую кампанию по одной странице, тогда как другая может создать для каждой кампании отдельный раздел. Одновременно с разделом создается обзорная часть (главная страница) и блог. Это облегчает распространение обновлений и объявлений среди участников команды.
Дерево страниц
Систематизировать содержимое раздела помогает иерархическое дерево страниц. Благодаря этому найти нужную информацию можно быстрее и проще. Страницы можно упорядочивать любым способом, создавая вложенные страницы внутри связанных с ними разделов и страниц.