Как confluence хранит файлы
Всех с наступившим 2015 Годом! В прошлом году мы с вами познакомились с базовыми возможностями Confluence и немного рассмотрели его с позиции “просто пользователя”.
Сегодня приготовим теплый напиток, устроимся удобнее у камина после праздничной суеты и, наслаждаясь спокойствием долгожданных выходных, рассмотрим Confluence в работе бизнес-аналитика, чтобы ты, дорогой читатель, мог начать первую рабочую неделю с прочтения этой самой статьи.
Трассировка требований в работе аналитика
Если провести опрос, то наверняка большинство наших с вами коллег знают, что такое матрица трассируемости, и при этом большинство не использует её на практике. Причины понятны: если в проекте несколько тысяч требований, не так просто осилить матрицу такой размерности. Никого не хочу обидеть, но для меня матрица трассируемости так и осталась академическим понятием. Однако это совсем не означает, что не нужно решать проблему взаимного влияния одних требований на другие. Ещё как надо! Чем больше проект и чем вы ленивее, тем более остро может стоять такая задача.
Поскольку Confluence изначально не является инструментом управления требованиями, он не предлагает готовое решение, как, например, готовая матрица трассируемости. Зато у него есть кое-что получше… ;)
Итак, как же упростить поддержку требований? Как работать так, чтобы описание можно было использовать повторно, не копируя каждый раз и не исправляя одно и то же в куче мест в спецификации?
Признаюсь, то что предлагает для этого Confluence – одна из моих любимых особенностей работы с этим инструментом.
Прежде чем рассказать о трассируемости, хочется сказать про возможность встроить одну страницу в другую с помощью макроса . Это решение “в лоб” – оно существует и его можно использовать вполне задорно. Да, в контексте управления требованиями такой способ решения не самый жизненный. Однако он может быть достаточно удобным, когда вам надо вставить какую-нибудь одну и ту же таблицу везде-везде. При этом вы избегаете дублирования требований, т.к. источник всегда один.
Так вот, есть и другое решение для упрощения поддержки требований, которое позволяет разместить все нужное в одном месте без нанесения ущерба структуре документа.
Представьте себе ситуацию классического изменения требования: спонсор продукта захотел, чтобы дата создания заказа в системе управления заказами повсюду отображалась не просто датой, как раньше, а датой со временем. Более того: в специально указанном формате!
Положим, у вас на проекте принят такой стиль описания требований, который предполагает, что каждый экран интерфейса пользователя и элементы управления имеют подробное текстовое описание каждого поля. У вас же:
100500 страниц системы работы с заказами.
вы хотите обновить требование к одному из важнейших полей заказа.
здоровая аналитическая лень отбивает всякое желание обновлять 100500 страниц спецификации, где упоминается дата заказа.
Что будем делать:
Создадим страницу для описания объекта “Заказ”. Тут опишем все поля объекта, включая поле “Дата заказа”. Каждому полю присвоим уникальный идентификатор (для даты заказа у нас будет идентификатор БО-ПЗ-80),
Во всех местах спецификации, где используется Дата Заказа, делаем ссылку на описание данного поля с указанием придуманного выше идентификатора БО-ПЗ-80, обозвав его, например, “Источник данных” – намекнем тем самым на структуру базы, что особо оценят программисты.
И немного волшебства: добавим колонку “Где Используется”, которая динамически отобразит список страниц, в которых упомянута наша дата (поле БО-ПЗ-80), решив тем самым проблему трассировки!
А так выглядит страница описания экрана со ссылками на описание полей бизнес-объекта (на иллюстрации смотрим колонку “Источник данных” и ищем строчку про дату заказа):
Таким образом, в последней колонке “Где используется” у вас всегда найдётся список страниц, который можно смело отдавать в тестирование для проверки того, что новый формат даты успешно изменён везде, как и требовалось в нашей задаче.
Чтобы овладеть магией, вам понадобятся только два макроса:
, который отобразит нам список страниц (а также блоков или комментариев – что именно выводить, можно настроить на ваш выбор), где используется искомое сочетание символов.
– спрячет массивный вывод результатов поиска и существенно “разгрузит” визуально вашу страницу.
А что если он захочет подписать документ?
Все скептики говорят примерно одно и то же: “Ваша вики это, конечно, модно и молодёжно, но мой заказчик требует пачку бумаги на стол, которую можно полистать и подписать”. На самом деле, этого же зачастую желают и руководители наших коллег, так что посыл, как говорят, понятен :)
Что касается темы подписи, то можно заморочиться и предложить рассмотреть дополнения, призванные настроить процесс работы с каждой страницей, процесс её утверждения и публикации. Примеры таких плагинов:
Однако понятно, что на самом деле вопрос о подписании документов задают не для того чтобы поговорить о реализации процессов жизненного цикла требований, а о возможности представить требования в старом добром и понятном виде документа, который можно пролистать от начала и до конца. Так вот, Confluence предлагает ряд возможностей для получения документов в удобном для печати олдскульном виде.
Опции для экспорта контента доступны из меню пользователя Tools:
Export to PDF – сохранить текущую страницу как PDF.
Export to Word – сохранить текущую страницу как Word-документ.
Export Page Tree to Word – сохранить дерево страниц как Word-документ – самая популярная возможность, когда нужно подписать целую спецификацию, состоящую не из одной, а из множества страниц вики.
А такие опции доступны администраторам:
Организация требований, и какие бывают правила
Так вот, Confluence не навязывает никаких правил. Немного выше мы с вами создали страничку для описания бизнес-объекта и несколько страниц для функциональных требований, просто потому что нам с вами так захотелось, исходя из целесообразности в конкретной задаче.
Если вам не понравилась получившаяся иерархия страниц, то страницы можно легко отсортировать, как вам нравится: например, отделить Бизнес-Объекты от Функциональных Требований.
Для этого постройте шаблон страницы, и впоследствии вы не только сэкономите себе время, создавая новую страницу с использованием этого шаблона, но и облегчите задачу начинающим коллегам.
Шаблон можно настроить в рамках вашего проекта или глобально для всех проектов, если вы администратор.
Впоследствии ваш шаблон будет отображён в списке выбора, который появляется при попытке создания страницы.
В Atlassian Market можно найти массу существующих бесплатных шаблонов. Начиная с некоторого времени, они стали называться Blueprint. Подробнее об этом пишут на сайта документации от Atlassian:
Таким образом, используя Confluence, вы в праве сами определять правила оформления требований. В тоже время для неприхотливой аналитики, можно вполне обойтись и готовым решением от Confluence “из коробки”.
Про работу с Jira и заморозку версий спецификации
Приходилось ли вам сталкиваться с жалобами команды на то, что они запутались и не могут разобраться в спецификации, а именно: непонятно, что из написанного нужно читать и кому именно это нужно, а что следует проигнорировать. Например, с точки зрения специалистов по контролю качества, может быть неочевидно как подойти к написанным требованиям, когда часть задокументированного функционала уже реализована и должна быть проверена, а другая часть ещё в разработке.
Если такой вопрос поднялся, то это не что иное, как увесистый камень в чудесный сад управления процессами на проекте. Часто случается, что именно аналитик отвечает если и не за все процессы, то, как минимум, за процесс управления требованиями. И действительно, коллеги, ввиду особенностей нашей с вами профессии мы склонны генерировать много контента, не всё из которого предназначено для немедленного прочтения каждым участником команды. Как известно, один из признаков эффективного стиля работы – умение беречь время своих коллег.
Так вот, если вернуться к тому, что от нас требуют, простыми словами, то от нас требуется понятно обозначить нужное и ненужное, важное и неважное, сделать это с учётом актуальной ситуации, особенностей проекта и роли на нём каждого отдельно взятого читателя проектной документации.
Вариант “внедрить и задействовать систему управления задачами”.
Вариант “задействовать версионность, которая присутствует в арсенале Confluence”.
Рассмотрим оба подхода.
В первом случае нам нужна система управления задачами, коей Confluence не является. Конечно, можно написать строчку текста, сказать, что эта строчка – на самом деле, задача, назначить ей дату исполнения и ответственного. Действительно, если это можно сделать в Excel, то почему это делать в Confluence?
Однако я настаиваю на том, что Confluence – это инструмент для совместной работы, но никак не система управления задачами. Поэтому в первом подходе мы предположим, что на вашем проекте задействована некая система управления задачами, которая позволяет контролировать сроки, назначать виновных и в целом, отслеживать прогресс на проекте. Jira – одна из таких систем, но если у вас TFS, IBM Rational, Mantis, Bugzilla, Redmine или что-нибудь ещё, что позволяет управлять задачами – это всё равно отлично сработает.
Идея в том, чтобы в Confluence держать подробное описание требований, а в системе управления задачами вести задачу со всеми её атрибутами и контролировать статус её выполнения в пределах жизненного цикла задачи в указанной системе. Простыми словами, в Jira мы указываем, что в рамках задачи Задача-Х100500 нужно добавить дату и указываем тут же, в подробностях задачи, ссылки на описание соответствующих страниц в Confluence с идентификаторами требований, касающихся даты:
Затем задача Задача-Х100500 в состоянии “Назначена” уходит к своему счастливому обладателю.
С другой стороны, в Confluence в каждом из указанных требований мы укажем идентификатор задачи, в рамках которой она должна быть выполнена (на иллюстрации смотрим колонку “Задача”).
Теперь для того, чтобы понять, реализовано ли поле “Дата”, будет достаточно взглянуть на статус соответствующей задачи в системе управления задачами. Статус задачи может быть, допустим, “Назначена”, “Выполнена”, “Закрыта” или, скажем, “Переоткрыта” – в зависимости от внедрённой системы управления задач и настроенного в ней процесса со статусами. Таким образом, пометка идентификатора задачи напротив требования позволяет нам судить о том, как относиться к каждому требованию: как к реализованному или, например, только как к запланированному пока что.
Всё-таки нужно упомянуть дополнительно Jira за особо глубокую интеграцию, которая позволяет не только создавать Jira Issues из Confluence, но также с помощью макроса выводить свойства задачи, такие как статус и заголовок. Свойства задачи отображаются прямо в Confluence, рядом с идентификатором задачи, таким образом, чтобы всё нужное и ценное было видно на странице и вам не нужно было отдельно заглядывать в систему управления задачами.
Макрос в работе:
Второй подход, про версионность – это примерно то, что делает сам Atlassian в своей документации. Каждый раз, когда выходит новая версия продукта, документация для предыдущей версии остаётся, но волшебным образом появляется и новая, очень похожая на старую, только более актуальная документация к последней выпущенной версии продукта!
На одном из проектов в моей практике накопилось слишком много разных цветных замечаний к каждому требованию. Особенность того проекта была такова, что для одних и тех же требований создавалось очень много изменений, которые в конце концов сильно засоряли документацию. Действительно, когда напротив описания требования к дате вы встретите более 2-х задач (где первая задача была на создание поля, а вторая – на его изменение), то становится проблематично определить, какова же судьба этого требования сейчас. Тогда было принято решение скопировать всю проектную документацию в новое пространство, очистить в скопированной версии все упоминания о будущем функционале и заморозить получившуюся копию, присвоив ей соответствующий номер релиза. Таким образом, у нас получилась документация, актуальная для определённого релиза нашего проекта.
В текущей версии мы удалили упоминание всех “устаревших” выполненных и закрытых задач, обеспечив тем самым “чистоту” описания и читабельность. У нас была “активная” версия документации, которая развивалась вместе с проектом и было несколько замороженных версий.
В нашем случае мы сделали даже интереснее: добавили в аналогичный блок ещё ссылку на эту же страницу в самой последней версии. Такая ссылка “Открыть это требование для последней версии продукта” у нас была доступна из старых “замороженных” версий документации. Вы тоже можете её сделать с помощью макроса . Подробнее про то, как это может выглядеть, нарисовано тут.
Такой процесс “Cрез версии” достигается копированием всего пространства в момент заморозки кода, а все описанные ссылки на другие версии настраиваются администратором как разметка страницы на уровне пространства вашего проекта. Таким образом, пояснение про версию отображается динамически на каждой странице пространства, и никому не нужно писать об этом, каждый раз создавая нужную страницу.
Так работает дополнение “Copy Space”:
Настройка разметки страницы:
А если не выйдет, то же самое можно попробовать сделать через экспорт и импорт всего пространства.
Идеологически мне очень нравится этот подход, но только при условии чтобы НЕ мне пришлось заниматься “зачистками” после каждой “заморозки” документации :)
Всё-таки описанный процесс предполагает существенные временные затраты на поддержание чистоты в момент поставки каждой новой версии документации.
Кажется, мы рассмотрели всё самое популярное из того, что мне нравится в работе с Confluence.
В качестве заключения надо сказать, что Confluence следует рассматривать, в первую очередь, как к средство совместной работы над контентом, коим являются в нашем случае требования. Прочие функции, такие, как управление задачами, планирование и контроль работ на проекте, разумно оставить специально предназначенным для этого другим инструментам, многие из которых могут быть успешно интегрированы с Confluence.
Наряду с таким пониманием, самым главным преимуществом Confluence для меня является свобода организации контента. Вы сами решаете, какой будет структура документации на вашем проекте или у вас в организации.
Таким образом, научившись “правильно готовить контент” так, как это нравится именно вам, Confluence сослужит вам отличную службу.
Было бы интересно увидеть ваши примеры использования Confluence в работе BA и в любой другой работе :)
Предлагаем Вашему вниманию статью слушателя нашего курса «Разработка технических текстов и документации» Георгия Полищука, посвящённую одной из наиболее популярных платформ для организации совместной работы над информацией Atlassian Confluence, которую часто используют в том числе для организации процессов документирования.
Содержание
Введение
Австралийская компания Atlassian известна своими программными продуктами для управления проектами разработки программного обеспечения. Широкую популярность завоевали инструмент управления проектами и баг-трекер JIRA, а также система совместной работы над информацией Confluence.
Confluence была разработана в 2004 году и быстро зарекомендовала себя как одна из самых удобных систем организации совместной работы над контентом, позволяющая создавать базы знаний, делать публикации, вести обсуждения, работать с документацией, хранить файлы, доступные через Web, создать корпоративный информационный портал и многое другое.
Confluence построена на вики-движке и как вики-система представляет собой сайт, страницы которого могут быть отредактированы множеством участников. Каждая правка страницы сохраняется в истории изменений, просмотрев которую, можно выяснить, какие правки и кем именно были внесены, а также вернуться к определенной правке, сравнить между собой различные версии редактирования или удалить ту или иную ревизию страницы.
Таким образом, как вики-система Confluence обладает такими преимуществами как централизованный доступ к данным, возможность совместной работы над ними, а также версионность.
Рисунок 1 — Централизованный доступ к данным — главное преимущество Confluence
В данной статье не будут рассмотрены вопросы, почему нужно выбрать именно Confluence и чем данная система лучше других. Статья посвящена тому, как Confluence можно использовать для работы с требованиями и разработки технической документации проекта: формирования технического задания, программы и методики испытаний, а также создания руководств администратора, пользователя и так далее. Поэтому данный обзор скорее ориентирован на тех, кто уже выбрал Confluence или желает попробовать данный продукт в работе над технической документацией.
Сначала я вкратце расскажу о базовых принципах работы в Confluence, далее рассмотрю некоторые технические задачи, встречающиеся при создании документации и то, как их можно решить с помощью возможностей данного ПО.
Кратко о принципах работы в Confluence
Рисунок 2 — Выбор шаблона пространства
На уровне пространства определяются права на просмотр, редактирование и комментирование статей, добавление файлов и тому подобное (рис. 5). Тот, кто создает пространство, по умолчанию становится его администратором.
Права доступа в Confluence разделены на три уровня — глобальный, уровень пространства и уровень страницы — и могут уточняться на каждом из них.
Кроме групп пользователей, специально созданных администраторами, в Confluence по умолчанию существуют следующие три группы:
- system-administrators (системные администраторы). Системным администратором становится пользователь, устанавливающий Confluence. Он имеет права назначать других системных администраторов, предоставляя им соответствующие права на глобальном уровне. Системные администраторы могут осуществлять все функции администрирования, включая предоставление прав пользователям;
- confluence-administrators (администраторы Confluence) могут осуществлять большинство администраторских функций (включая предоставление прав пользователям), кроме тех, которые могут поставить под угрозу безопасность системы;
- confluence-users. Это группа, в которую по умолчанию добавляется любой новый пользователь Confluence.
Рисунок 4 — Настройка прав доступа на глобальном уровне
Рисунок 5 — Настройка прав доступа на уровне пространства
Рисунок 6 — Выбор шаблона страницы
Для редактирования и добавления информации на страницы используется ряд базовых инструментов редактирования, которые доступны на панели в верхней части окна (рис. 7).
Рисунок 7 — Режим редактирования страницы
Для добавления файлов, диаграмм, оглавления, различных отчетов и тому подобного используются макросы.
Рисунок 8 — Макросы
Макросы делятся на следующие категории (рис. 8):
В Confluence используется система оповещений об изменениях контента страниц и пространств, на которые подписан пользователь. Также обратить внимание того или иного пользователя на страницу можно, просто поставив символ @ и начав набирать его имя (рис. 9). После сохранения страницы или комментария данному пользователю придет уведомление по почте.
Рисунок 9 — Упоминание пользователя
Confluence может обмениваться информацией с другими приложениями Atlassian, например, с системой управления проектами JIRA. Более того, основной выигрыш от использования Confluence получат именно те, кто планирует использовать ее вместе с остальными продуктами Atlassian.
Confluence, как было сказано выше, позиционируется как инструмент совместной работы над информацией, а поэтому данное ПО предполагает широкий спектр возможностей его применения. В зависимости от целей использования продукт можно кастомизировать под разнообразные нужды — в стандартную комплектацию входит довольно ограниченный набор базовых возможностей, а все остальная специфика настраивается подключением платных и бесплатных дополнений, которые доступны на сайте Atlassian Marketplace. Среди этих дополнений есть как собственные разработки Atlassian, так и плагины, написанные сторонними разработчиками. Именно установкой и настройкой специальных плагинов можно решить большую часть задач, встречающихся при использовании Confluence для создания документации.
Документирование в Confluence
Задачи
Во-первых, перед предприятиями, которые работают с госзаказами, зачастую стоит задача создания документации проекта по ГОСТу, что, помимо прочего, предполагает, что документы должны быть предоставлены в том числе в «бумажном», а не только «электронном» виде.
Таким образом, необходимо иметь возможность экспортировать контент сайта Confluence в оформленный по ГОСТу текст со всеми необходимыми отступами, правильным оформлением шрифтов, списков, таблиц, заголовков и прочего.
Во-вторых, работа с требованиями предполагает необходимость их единого источника, к примеру, для формирования таких документов как Техническое задание, Частное техническое задание, Программа и методика испытаний, а также для возможности создания отчетов и взаимодействия с инструментом управления проектами (например, с JIRA). Другими словами, задача состоит в создании структуры, которая вмещала бы в себя:
При этом данная структура должна обладать возможностью тиражирования для создания большого количества требований.
В-третьих, эксплуатационная документация (руководства пользователя, администратора и тому подобное), как правило, обновляется с каждой версией выпускаемого продукта, что предполагает необходимость такой структуры, которая содержала бы различные версии одной и той же страницы с небольшими изменениями контента.
Помимо перечисленных, существуют еще несколько частных задач:
- необходимость отслеживать состояние проработки требования и степень его готовности для включения в документ. Другими словами, возможность создания цепочки статусов в привязке к странице требования с возможностью формирования по ним отчетности и оповещения ответственных пользователей о переходах от одного статуса к другому;
- необходимость создания отчетов по требованиям с возможностью добавления новой метаинформации к требованию прямо из отчета: принадлежность требования к определенной категории (например, тому или иному направлению или модулю в составе разрабатываемого ПО), сроку исполнения; возможность добавления комментариев без перехода непосредственно к странице требования;
- необходимость работы в Confluence с контентом файлов MS Word, то есть возможность импорта файлов doc- и docx-формата.
Описанные выше проблемы создания технической документации решаются в основном благодаря использованию возможностей нескольких дополнений, о которых далее и пойдет речь.
Решения
Экспорт документации в файлы MS Word
Проблема экспорта документации в docx-файлы решается использованием возможностей плагина Scroll Office. Он позволяет подгрузить в Confluence шаблон MS Word, в котором пользователь создает необходимые стили абзаца, таблиц, списков, заголовков, а также настраивает колонтитулы, оглавление, поля страницы и прочее в соответствии с ГОСТом. К примеру, плагин выгружает таблицы со стилем Scroll Table Normal. При создании шаблона пользователь должен создать стиль таблицы с таким названием и задать для него необходимые параметры.
Также на титульной странице шаблона можно добавить огромное количество тэгов для заполнения метаданными со страницы Confluence:
- заголовок,
- подзаголовок,
- название проекта,
- год создания документа,
- шифр документа,
- ФИО и должности ответственных лиц, а также места для подписи и печати — причем, с возможностью регулировки количества данных полей).
Все это позволит использовать единый шаблон для выгрузки в соответствии с правилами стандарта большинства необходимых документов. Шаблоны можно подключить как глобально, так и на уровне пространства.
После экспорта заголовки дочерних страниц станут заголовками первого уровня в документе, дочерние дочерних — второго и так далее. Если внутри страницы Confluence присутствуют заголовки, они также будут преобразованы в заголовки соответствующих уровней в документе. К примеру, приведенная ниже структура в Confluence
- Заглавная страница (с которой происходит экспорт иерархии)
- Дочерняя страница 1
- Заголовок 1
- Заголовок 2
- Заголовок 1
- Дочерняя страница 3
- Дочерняя страница 4
будет иметь следующую структуру в документе:
Заглавная страница (Название документа)
1 Дочерняя страница 1
2 Дочерняя страница 2
2.2 Дочерняя страница 3
2.3 Дочерняя страница 4
Кроме того, со страниц Confluence при помощи макросов Scroll Office можно сделать следующее:
- в необходимых местах добавить разрыв страницы;
- перейти с портретной на альбомную ориентацию страницы;
- регулировать стиль экспорта таблицы. Например, если таблица, экспортированная с помощью заданного в шаблоне стиля, по умолчанию применяющегося для таблиц, не помещается даже на альбомную страницу, с помощью макроса можно указать другой стиль экспорта, предварительно настроив его в шаблоне);
- настроить ширину столбцов таблицы;
- создать глоссарий (в этом случае также придется дорабатывать шаблон);
- исключать контент из экспорта (например, черновой вариант требования, обсуждения и прочее) и, наоборот, создавать контент, доступный только для экспорта и невидимый из Confluence в режиме просмотра;
- создать сквозную нумерацию рисунков и таблиц.
Таким образом, один раз разобравшись со стилями в шаблоне и научившись работать с макросами Scroll Office, вы решите все проблемы с переводом документации в формат MS Word.
Создание единой структуры требования для использования в нескольких документах
К вариантам можно привязывать не только блоки внутри страниц, но и отдельные страницы. Таким образом, в рамках одного пространства можно формировать несколько документов с общими разделами.
![10_1]()
![10]()
Рисунок 10 — Пример страницы требования, относящегося к нескольким документам
Для создания такой структуры нужно, во-первых, активировать возможность добавления вариантов в установках пространства и создать необходимые варианты документации (рис. 11):
![11]()
Рисунок 11 — Создание вариантов документации на уровне пространства
Во-вторых, создать шаблон функционального требования примерно по следующей схеме (рис.12):
![12-1]()
![12-2]()
Рисунок 12 — Пример шаблона требования
К шаблону также рекомендуется добавить метку, по которой можно будет вести отчетность по страницам требований.
После этого при создании страницы данный шаблон можно будет выбрать наряду со стандартными (рис. 13).
![13]()
Рисунок 13 — Создание страницы требования
Далее, необходимо создать страницы требований по шаблону, заполнив соответствующие поля и привязав страницы к созданным вариантам (рис. 14).
![14]()
Рисунок 14 — Привязка страницы требования к вариантам
После этого на странице появится информация о том, что она привязана к указанным вариантам, а при наведении курсора мыши появится всплывающее окно, которое покажет, какие именно варианты задействованы (рис. 15).
![15]()
![16]()
Немаловажным преимуществом данного плагина также является возможность создания страниц с одинаковыми заголовками. Дело в том, что в стандартной комплектации названия страниц привязаны к постоянным ссылкам, что не позволяет создать страницы с одинаковыми названиями в пределах пространства. Scroll versions делает название страницы независимым от ее постоянной ссылки.
Варианты можно использовать также для создания документации на разных языках.
Создание эксплуатационной документации для различных версий продукта
Кроме вариантов документации, Scroll versions позволяет создавать ее версии. Версионнсть также настраивается на уровне пространства.
Как и в случае вариантов, к версиям можно привязать отдельные страницы (отсутствующие в другой версии) и создавать различные версии одной и той же страницы. Главное отличие от вариантов состоит в том, что создается несколько модификаций одной и той же страницы с отдельным контентом и отдельной историей изменений. Очередная версия страницы создается на основе предыдущей.
Версии можно сравнивать между собой как на уровне страницы (рис. 17), так и на уровне пространства.
![17]()
Рисунок 17 — Сравнение версий страницы
Привязка бизнес-процессов
![18]()
Рисунок 18 — Переход к новому состоянию бизнес-процесса работы с требованием
![19]()
Рисунок 19 — Пример отчета
Импорт документов MS Word
Импорт документов MS Word — встроенная функция. При импорте документа его разделы в зависимости от уровня заголовков можно преобразовать либо в отдельные страницы Confluence, либо в разделы на самих страницах.
![20]()
Рисунок 20 — Импорт документа: выбор уровня заголовка, заканчивая которым документ будет разделен на страницы Confluence
Еще несколько полезных плагинов
Заключение
В статье я рассмотрел пути решения технических проблем, с которыми столкнулся при создании документации в своей компании. Confluence хорош тем, что его можно адаптировать под различные условия в зависимости от специфики проекта или нужд организации. Свобода в организации контента — главное преимущество данного ПО. После того как вы настроите и научитесь использовать Confluence, он сослужит хорошую службу вашим коллегам – техническим писателям, аналитикам и менеджерам.
Confluence – это новый подход к совместной работе команд. Если вы потратите время для понимания основ (и это правда не займёт много времени – обещаю!), то это даст полную свободу действий для использования Confluence. Мы надеемся, что Confluence скоро станет незаменимым инструментом в рабочем процессе для планирования, дискуссий и конечно же помощником в работе.
- Пространство - то, над чем работает ваша команда. Информация о текущих проблемах и протоколах собраний, проектных планах и сроках, техническая документация и др. — собирается в пространстве. Это информационный портал для вашей команды. Маленькая команда знает, что ей нужно пространство как для себя, так и для своих проектов.
Confluence упрощает совместную работу с другими командами и департаментами. Мы рекомендуем организовать пространство для каждой команды, так же как и для серьёзных корпоративных проектов. Это ключ к пониманию того, что пространство это контейнер – содержащий необходимую информацию для вашей команды или для проекта над которым вы работаете.
Главный совет
Если вы новый пользователь, которого пригласили как члена команды, ознакомьтесь с существующими пространствами Confluence. Выберите Пространства в главном меню и изучите каталог пространств в выпадающем меню
Из профиля пользователя в выпадающем меню (верхний правый угол), выберите "Добавить личное пространство"
Личное пространство наполняется информацией которая вам необходима. Это место для своих черновых идей, своей биографии и контактных данных, для проектных файлов. Управлять приватностью легко (подробнее ниже) создавайте столько черновиков столько, сколько вам нужно!
Из выпадающего меню Пространства, выберите "Создать пространство"> далее "Командное пространство"
Создайте пространство для вашей команды. Поскольку Confluence идеален для командной работы, вы наверняка захотите сделать это пространство приятным и полезным для ваших коллег.
Правильное создание страниц в Confluence – важно для успеха. Предполагаю, что у вас нет нужной информации для добавления, поэтому рекомендую начать с выбора шаблона “Протокол собраний”. Создайте страницу протокола собраний для предстоящей встречи, это нужная практика для вас.
- Если вы создаёте страницу из главного меню в верхней части экрана(синяя кнопка Создать), убедитесь что вы выбрали соответствующее пространство
- Если вы новичок в Confluence, начните с шаблона
Изучите права. В совокупности с организацией вашей работы в пространствах и созданием страниц в своих пространствах, думайте о общедоступности вашей информации. В Confluence, права помогают изменять список тех, кто просматривает и редактирует содержимое контента над которым вы работаете. Это важно, так как возможно появятся файлы к которым вы захотите ограничить доступ. Ограничивайте доступ изменяя приватность своих файлов или файлов вашей команды или вашей компании.
Главный совет
Находясь в пространстве кликните "Инструменты пространства" > "Права"
Права важны в Confluence. Они дают вам управлять доступом пользователей к чему либо. Если вы создали пространство для своей команды, убедитесь в том, что каждый из членов команды в праве добавлять и просматривать данные.
Главный совет
Изменять права доступа к определенным страницам, можно кликая на троеточие в верхнем правом углу страницы.
- Разрешите членам компании, просматривать и добавлять контент в пространстве, но не разрешайте удалять
- Дайте полный доступ вашей команде (это право удаление и добавление контента)
Теперь, вы уже владеете основами, продолжайте в том же духе и организуйте работу в Confluence. После того как вы закончите, возвращайтесь и вы узнаете много нового.
Создавайте контент, сотрудничайте и организуйте всю рабочую информацию в одном месте. Confluence — это пространство для команд, в котором накопленные знания объединены с возможностями для совместной работы. Динамические страницы представляют собой площадку для творчества, сбора информации и совместной работы участников команды над любыми проектами и идеями. Благодаря разделам можно структурировать и организовывать работу в команде, а также предоставлять общий доступ к базе знаний организации и к информации, необходимой участникам для эффективной работы. Подробнее о возможностях Confluence.
Confluence могут использовать команды любого размера и типа — как те, которые занимаются крупными, критически важными проектами и должны строго следовать рекомендациям, так и те, которые ищут пространство для формирования командной культуры и более открытого и естественного способа взаимодействия друг с другом.
Вооружившись Confluence, команда сможет быстро принимать решения, добиться согласованности и достичь больших результатов при совместной работе.
Варианты размещения
Confluence может работать в облаке, в вашей собственной инфраструктуре или в большом масштабе. Изучите предложенные далее варианты размещения и определите, какой из них лучше всего подходит вашей организации.
Cloud
В варианте Confluence Cloud мы разместим сайт за вас: никаких серверов, хранилищ или технического обслуживания не потребуется. Вы получите мгновенный доступ к новейшим возможностям с автоматическим обновлением, оптимальной производительностью и эластичным масштабированием благодаря размещению в облаке AWS.
![Data Center]()
Data Center
Confluence Data Center — это решение для самостоятельного управления с разными вариантами конфигурации, которые позволят выстроить командную работу с учетом потребностей организации. Режим «Только чтение» и гибкость развертывания с привлечением поставщиков IaaS (таких как AWS и Azure) обеспечат бесперебойный доступ и масштабирование с учетом потребностей ваших пользователей.
Server
При выборе варианта Confluence Server вы размещаете Confluence на собственном оборудовании и можете настраивать параметры установки по своему усмотрению. Этот вариант подходит командам, которые хотят контролировать все детали, установить более жесткие требования к управлению данными и готовы к любым сложностям, связанным с самостоятельным размещением.
Для варианта Confluence Cloud мы предлагаем тарифные планы Free, Standard и Premium, рассчитанные на команды с разными потребностями. Подробнее о планах подписки на Confluence Cloud см. в этом обзоре.
Основные термины
Раздел
Дерево страниц
Читайте также:
- Дочерняя страница 1
