analyst.by

Белорусское сообщество бизнес и системных аналитиков

Confluence в жизни аналитика — Часть 1

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

Как известно, если есть интерес, то поступает и предложение :)

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

Статья ориентирована на тех читателей, кто уже сделал свой выбор (или выбор уже сделан за них), а также на тех, кто желает попробовать использовать Confluence в работе.

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

Вторая часть статьи будет ориентирована больше для работы, чем для знакомства. В ней рассмотрим некоторые лайфхаки, которые существенно упрощают жизнь BA, SA, PM, QA, …(добавьте свой вариант). Постараюсь не забыть о возможностях Confluence, без которых мне было бы уже трудно представить приятную работу.

Не обойдётся и без порции Рождественской Магии в канун праздников…

Модульность Confluence и Atlassian Market

“Базовая комплектация” Confluence вполне себе позволяет выполнять простые  операции по управлению требованиями с достаточной степенью комфорта. Тем не менее, много-много радостей от работы доставят платные и бесплатные дополнения. У Atlassian есть собственный маркет, в котором можно выбрать add-on на ваш вкус, в соответствии с потребностями вашего процесса или особенностями проекта. Среди дополнений, которые можно скачать и установить, встречаются как наработки Atlassian, так и предложения сторонних разработчиков, которые, по всей видимости, изначально разработали дополнения для себя, а затем представили его широкой аудитории.

Обзор каждого из дополнений для Confluence – это тема для отдельной статьи, но я всё же не удержусь от упоминания самых-самых, которые использую сам.

Любителям MS Word!

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

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

Итак, давайте рассмотрим случай, когда вам прислали MS Word документ с начальными требованиями и администратор создал пустой (или не совсем пустой) спэйс (Space или пространство имён) для вашего проекта.

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

Во избежание путаницы, именам в одном пространстве имён не дают более одного значения. Например, в пространстве имён улиц любого города названия улиц, как правило, не повторяются.

Для нас с вами такие пространства удобно использовать как разделы для проектов: каждому проекту свой раздел, своё пространство :) Так, в каждом проекте могут быть страницы с одинаковым именем, которое может встречаться и в другом проекте, как например  “Страница входа в систему”, описание которой есть, наверняка найдётся в каждом проекте.

У вас есть документ. Есть вики. Вы смотрите на документ. Смотрите на вики. Смотрите снова на документ. Смотрите снова на вики. Думаете. Ещё думаете. Вики смотрит на вас… Что с ними делать?

Иногда начинающие пользователи просто берут и прикрепляют документ как приложение к страничке вики. Если при этом было установлено и включено бесплатное дополнение Office Connector, которое включено в базовую комплектацию, то довольный пользователь радостно обнаруживает текст загруженного документа встроенным прямо в страничку, с кнопкой для редактирования.

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

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

Такой подход НЕ предполагает удобное редактирование.

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

а) Импорт документа. Про него ниже.

б) Способ “от кэпа” – копирование контента из документа. На самом деле, может быть вполне оправдано, когда вы хотите правильно сформулировать и оформить требования, “пропустив исходный текст через себя”.

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

Форматирование – переформатирование..

Текст перенесён. Теперь перед нами встала задача его редактирования. Могу ошибиться, но предположу, что первое, что отличает текстовый редактор MS Word от текстового редактора Блокнот, – это, пожалуй, возможность “богатого” форматирования текста, призванного сделать текст более читабельным: Жирность, Курсив, Подчёркнутость, Заголовки, Списки…

Все эти базовые приёмы форматирования текста также хорошо и на лету работают в Confluence, как в редакторе от Майкрософт.

Подозреваю, что даже ещё более «на лету», чем в самом Ворде :)

С одной стороны, как обычно, присутствует панель WYSIWYG редактора с привычными опциями форматирования и для любителей горячих клавиш и быстрого набора красивых текстов сочетания Ctrl+B, Ctrl+U, Ctrl+I и автонумерацию никто не отменял.

С другой стороны – доступна вся мощь работы с wiki markup language…

Ссылки – гиперссылки и что такое wiki markup language

Так вот, в отличие от работы в MS Word, вы можете добавлять ссылки на существующую страницу даже без обращения к опции меню “добавить ссылку”. Не обязательно ходить в разные там меню: когда вы работаете в вики, ссылки можно вставлять прямо по ходу написания текста, открыв квадратную скобку “[…” и начав писать имя страницы, на которую вы хотите сделать ссылку. Confluence подскажет вам выпадающим списком, какие страницы уже созданы, и вы можете выбрать существующую страницу, на которую должна указывать ссылка.

А ещё вы можете написать заголовок несуществующей страницы и закрыть скобку “]”. Такая ссылка будет подсвечена по-особенному: нажав на неё, Confluence предложит создать новую страницу с заголовком, соответствующим введённому тексту. Заголовок страницы вы, впрочем, можете изменить, изменив заодно и URL, но все встречающиеся в вики ссылки на вашу страницу при этом сохранятся, что может быть неожиданным, но приятным сюрпризом!

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

Ветераны помнят время, когда можно было переключиться в режим wiki markup и насладиться работой в plain text редакторе с использованием олдскульной разметки во всей красе, как показано на фотографии.

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

Так выглядит результат редактирования.

Возможности быстрого форматирования удачнее всего, на мой взгляд, иллюстрирует видео от производителя, выпущенное в преддверии той версии, когда был отменён wiki markup в своём классическом смысле:

https://www.youtube.com/watch?v=yDqxZ4hWZDI

 

А как сделать ссылку на конкретное место на странице?

А очень просто. Как мы с вами уже знаем, ссылка записывается, например, вот так: “[ссылка на страницу A]”.  И так: “[ссылка на страницу A|Текст ссылки]”.

Если вы хотите сделать ссылку на секцию на вашей странице, то добавьте к заголовку секции решётку “[#Секция]” или так “[#Секция|Текст ссылки на Секцию]”.

А если вы хотите сделать ссылку на произвольное место на странице – используйте макрос {anchor} Подробнее о нём на wiki Atlassian.

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

Что ещё за макросы?

Макросы — это встроенные возможности Confluence, придуманные для облегчения жизни пользователям и для открытия доступа к бесконечным возможностям работы!  Очень часто дополнения, представленные для Confluence в Atlassian маркете, – это именно возможности использования макросов. В языке вики-разметки макрос начинается открывающей фигурной скобкой “{“ и заканчивается закрывающей “}”. Есть и такие, которые подгружают к странице целые компоненты сторонних систем, как например макрос {mockup}, позволяющий рисовать Balsamiq Mockups прямо не уходя со страницы.

Некоторые популярные макросы:

  • Макросы для вставки документов: excel, word, pdf,

  • Макросы для интеграции с EverNote, Google Drive, Dropbox

  • Макросы форматирования {toc}, {color}, ….

  • Макросы для работы с таблицами

 

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

В следующей части мы рассмотрим, как же применить возможности Confluence к работе аналитика:

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

  • рассмотрим способ организации требований и существующие подходы к структуре

  • и раскроем некоторые секреты про то, как Confluence помогает во  взаимодействии с командой и с заказчиком.

Пока!

[Обновлено] Продолжение статьи: Confluence в жизни аналитика — Часть 2

Автор:

Денис Ардабацкий

Старший бизнес-аналитик в Oxagile

 


31 Декабря, 2014


Комментарии к “Confluence в жизни аналитика — Часть 1”
  1. Предлагаю сделать обзор плагинов.
    Особенно интересует, что есть для трассировки требований — в данном случае помог бы плагин, который бы визуализировал связи между страницами по ссылкам в них в виде графа 

  2. Ощущение после прочтения — художественный пересказ справки к Confluence с вкраплением придыханий.
    Хотя, возможно, будет полезно тем, кто вообще не представляет, что это такое (и не умеет пробовать trial-версии).

    • Ну справка всё же побольше будет…
      А вообще любое совпадению со справкой считать случайностью :)
      По-честному её открыл только свериться в нескольких местах 2й части, там и ссылочка на неё будет.

    • Денис, а разве ваши ощущения не соответствуют той цели, которую поставил автор?
      Ваш комментарий как-бы намекает на то, что ваши ожидания от статьи не оправдались, но при этом вы не описали ни ваши ожидания, ни то, как эти ожидания следовало реализовать.

      Мне почему-то кажется, что любая статья, описывающая функции продукта, будет «художественным пересказом справки».

      Я увидел цель автора в том, чтобы для новичков, которые не знакомы с Confluence, описать набор прикольных фишек, которые автор считает уместным использовать в работе аналитика. Таким образом, мотивировать аналитика попробовать инструмент, дать ему что-то на старте. Как мне кажется, автор отлично справился с задачей. За что ему спасибо, с удовольствием прочитал и прочту ещё раз, если появится возможность попробовать Confluence.

      • Понимаю как одного Дениса, так и другого :). Денис-автор, спасибо за статью — обзор Confluence на любом уровне, в любом случае, полезен, т.к. он набирает обороты, чему в какой-то мере поспособствует и победа на митапе analyst.by. Кстати, я особо и не понял, почему Confluence победил с таким перевесом — да, про Word было немного неубедительно, но, блин, аналитики то должны прекрасно представлять возможности сего текстового редактора и того, что можно к нему приинтегрировать при желании. Почему слили EA как вполне себе огоньковую RMS — мне непонятно. Тем не менее, Confluence, конечно, жжет и это круто, что есть те, кто движет альтернативные варианты хранения требований в массы.

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

        • Ребята, спасибо за ваши комментарии!
          Таки вышла уже и вторая часть ;) 
          Уж не обещаю, что в ней найдётся описание фишек, не раскрытых справкой. Всё-таки система, которая создана для работы с документацией обязывает к соответствующему уровню “документирования самой себя» :)

           
          Однако, есть основание полагать, что она может оказаться интересной и для тех, кому было скучновато читать первую. Помимо любимых мною фишек, описание которых есть также в справке, ввиду того, что они обязаны там быть, во второй части захотелось показать кое-что из личного опыта и из опыта коллег, с которыми когда-то посчастливилось работать вместе. Спасибо им и спасибо тем хорошим и красивым людям, кто задавал интересные вопросы на кануне! 
          На сколько получилось достигнуть желаемого в статье и раскрыть нечто нераскрытое ранее — судить только вам (только плз не очень строго :)
           
          А 1я часть действительно ориентирована на начинающих, возможно по-здоровому ленивых пользователей. НО я категорически не соглашусь,  что она написана для тех, кто не умеет пробовать триал. Догадываюсь, что Денис-критик согласится, что, например, некоторые руководители и успешные владельцы бизнеса, не пробуют триал по более достойным причинам, чем неумение. Как раз один из таких уважаемых достойных людей (на него я даже хотел бы быть в чём-то похож!) своим примером работы с вики “вдохновил» меня упомянуть в статье про способы прикрепления документов. Немного трудно было спокойно работать с его Excel файлом на Вики-странице :)
          Поэтому, мне всё ещё хочется верить, что статья нашла своего, в меру искушенного читателя — уж очень хочется нанести ему непоправимую пользу :)

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

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

        Есть (некие) пространства.
        Исходный контент можно импортировать или скопировать.
        Можно форматировать (WYSIWYG редактор).
        Можно делать ссылки.
        Есть макросы.

        Даже если расслабиться и поискать набор прикольных фишек, о которых вы говорите, то я его не увидел.
        Почему я должен попробовать именно этот инструмент? Что он мне даст нового и/или полезного?

        • Денис, но ведь никто и не пытался продать тебе Confluence.

          Скажи лучше, что конкретно ты ожидал увидеть. О чем хотел бы узнать подробнее? Критиковать — это, конечно, хорошо. Но давай сделаем критику конструктивной :)

            • Никто не пытался. Но благодаря вам, я уже подумываю написать в Atlassian, что у народа складывается мнение, что я продаю их продукт. Вдруг вознаградят :)
              Вообще, мне действительно нравится работать с данным инструментом и.
              После митапа, где выяснилось, что достаточно много коллег не в курсе про него, и было предложено подготовить статью, это примерно совпало с моим намерением. Поэтому все мои придыхания в этой статье были искренни.
              В плане инструмента, каждый выбирает сам. Моей целью не было порадовать именно вас. У вас своё мировозрение, сложившееся на своём опыте. Однако, спасибо что прочитали. Некоторые ваши комментарии ко второй части показывают, что действительно кое-какие вопросы, следовало раскрыть лучше.

  3. Денис, мне было тяжело читать ваши статьи. Попытаюсь сформулировать почему:

    1. У вас много лишнего в контенте. К чему все эти красивые обороты (старый добрый и махровый), отвлеченные фразы (У вас есть документ. Есть вики. Вы смотрите на документ. Смотрите на вики. Смотрите снова на документ. Смотрите снова на вики. Думаете. Ещё думаете. Вики смотрит на вас… Что с ними делать?)?
    2. Структуру статей можно и (имхо) нужно улучшать. Чётче выделяйте главное, не размазывайте мысль на несколько абзацев.
    • Мне нравится именно так писать. Уверен, что есть те, кому нравится именно так читать. А кому-то, как вам, ближе читать справку. Это нормально.

      Буду признателен если скинете пару своих статей. Я, действительно, начинающий автор. Было бы интересно поучиться на практике.
      Спасибо.

    • Денис, это замечания более уместно направлять в адрес редакции сайта (если такая имеется). Именно редакторы должны в конечном счёте следить за соответствием статьи некоторым принятым на сайте критериям.

      • Виктор, на даный момент авторам предоставляется практически максимальная свобода в изложении мыслей. Редактуру проходят только наиболее откровенные описки, нестыковки и т.п. Авторский стиль, по возможности, стараемся сохранить, чтобы «почерк автора» оставался нетронутым.

Добавить комментарий
Также Вы можете войти используя: Facebook Google