Как сделать таблицу в confluence

понедельник, 7 августа 2017 г.

Как начать работать с Confluence (manual)

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

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

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

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

1.1. Создание

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

3. Таблицы. Table

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

5. Списки

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

буллиты — *
нумерация — 1

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

6. Скриншоты

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

7. Ссылки

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

12. View in Hierarchy

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

13. Log out

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

15. Мои спейсы

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Источник

Использование JIRA и Confluence в большом проекте

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

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

Портал проекта — Confluence
Confluence — это удобный и продвинутый wiki движок от компании Atlassian. Он позволяет организовать внутренний интернет портал и дать доступ к нему всем пользователям — для редактирования или для чтения.

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Проектный портал содержал все проектные материалы, часть которых мы сделали в виде иерархии страниц.

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

Все контрактные документы, которые должны сдаваться в качестве результатов проекта, выкладывали на соответствующую страницу в Word, Excel или pdf. Таким образом все проектные материалы, были в одном месте, структурированы, и не было путаницы с версиями.

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Процедуры и регламенты

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Риски и открытые вопросы

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Просматривая список можно перейти на соответствующую страницу, прочитать описание риска и посмотреть план действий по нему.

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Рассмотрим варианты, которые можно использовать, которые позволяют напоминать о действиях участникам и контролировать их исполнение.

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence
В отличие от предыдущего варианта эта задача может быть настроена так, чтобы ее мог закрыть только ответственный, отличный от исполнителя, что дает хороший контроль ее выполнения.

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

JIRA — Система для ведения списков, поручений, задач

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

Ведение разработок с помощью JIRA подробно описано в статье Управление разработками. Здесь я расскажу о контроле поручений и интеграции с Confluence.

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

На странице протокола появится ссылка на задачу, а в задаче JIRA будет ссылка на страницу в Confluence.

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

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

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Работа с JIRA требует определенной квалификации и опыта. Здесь я описал некоторые варианты использования, однако на самом деле их гораздо больше. Прелесть в том, что можно начать с самых базовых вещей, и это уже будет работать, а затем развивать систему по мере приобретения опыта и понимания потребностей.

Кроме Confluence, в интеграции с JIRA, мы также использовали BitBucket, также продукт Atlassian — репозиторий разработок, позволяющий отслеживать версии кода. Для этих же целей на другом проекте использовали бесплатный SVN.

Множество плагинов позволяет расширять функциональность системы, в частности, для интеграции с MS Project или реализации диаграммы Гантта непосредственно в JIRA.

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

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

Источник

Как сделать таблицу в confluence

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluenceПредлагаем Вашему вниманию статью слушателя нашего курса «Разработка технических текстов и документации» Георгия Полищука, посвящённую одной из наиболее популярных платформ для организации совместной работы над информацией Atlassian Confluence, которую часто используют в том числе для организации процессов документирования.

Содержание

Введение

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

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

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

Таким образом, как вики-система Confluence обладает такими преимуществами как централизованный доступ к данным, возможность совместной работы над ними, а также версионность.

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 1 — Централизованный доступ к данным — главное преимущество Confluence

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

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

Кратко о принципах работы в Confluence

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 2 — Выбор шаблона пространства

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 3 — Пример пространства. Слева изображено дерево страниц, справа открыта страница «Общие сведения»

На уровне пространства определяются права на просмотр, редактирование и комментирование статей, добавление файлов и тому подобное (рис. 5). Тот, кто создает пространство, по умолчанию становится его администратором.

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

Зарегистрированных в Confluence пользователей рекомендуется разделить на группы в зависимости от должностных обязанностей и принадлежности к проекту/команде, и затем присваивать права уже на уровне групп.

Кроме групп пользователей, специально созданных администраторами, в Confluence по умолчанию существуют следующие три группы:

При необходимости права доступа можно настроить и для незарегистрированных в Confluence пользователей.

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 4 — Настройка прав доступа на глобальном уровне

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 5 — Настройка прав доступа на уровне пространства

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 6 — Выбор шаблона страницы

Для редактирования и добавления информации на страницы используется ряд базовых инструментов редактирования, которые доступны на панели в верхней части окна (рис. 7).

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 7 — Режим редактирования страницы

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 8 — Макросы

Макросы делятся на следующие категории (рис. 8):

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 9 — Упоминание пользователя

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

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

Документирование в Confluence

Задачи

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

Таким образом, необходимо иметь возможность экспортировать контент сайта Confluence в оформленный по ГОСТу текст со всеми необходимыми отступами, правильным оформлением шрифтов, списков, таблиц, заголовков и прочего.

Во-вторых, работа с требованиями предполагает необходимость их единого источника, к примеру, для формирования таких документов как Техническое задание, Частное техническое задание, Программа и методика испытаний, а также для возможности создания отчетов и взаимодействия с инструментом управления проектами (например, с JIRA). Другими словами, задача состоит в создании структуры, которая вмещала бы в себя:

При этом данная структура должна обладать возможностью тиражирования для создания большого количества требований.

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

Помимо перечисленных, существуют еще несколько частных задач:

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

Решения

Экспорт документации в файлы MS Word

Проблема экспорта документации в docx-файлы решается использованием возможностей плагина Scroll Office. Он позволяет подгрузить в Confluence шаблон MS Word, в котором пользователь создает необходимые стили абзаца, таблиц, списков, заголовков, а также настраивает колонтитулы, оглавление, поля страницы и прочее в соответствии с ГОСТом. К примеру, плагин выгружает таблицы со стилем Scroll Table Normal. При создании шаблона пользователь должен создать стиль таблицы с таким названием и задать для него необходимые параметры.

Также на титульной странице шаблона можно добавить огромное количество тэгов для заполнения метаданными со страницы Confluence:

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

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

будет иметь следующую структуру в документе:

Заглавная страница (Название документа)

1 Дочерняя страница 1

2 Дочерняя страница 2

2.2 Дочерняя страница 3

2.3 Дочерняя страница 4

Кроме того, со страниц Confluence при помощи макросов Scroll Office можно сделать следующее:

Таким образом, один раз разобравшись со стилями в шаблоне и научившись работать с макросами Scroll Office, вы решите все проблемы с переводом документации в формат MS Word.

Создание единой структуры требования для использования в нескольких документах

Проблема возможности использования единой структуры требования в различных документах решается установкой плагина Scroll versions. Он позволяет создать страницы, контент которых может относиться к разным вариантам документации. К примеру, на странице требования можно создать два блока, один из которых попадает при экспорте в первый документ, а другой — во второй. При этом требование будет обладать единой структурой метаданных и относиться к одной задаче в Jira, формулировку требования для второго документа можно будет формировать, «имея перед глазами» формулировку первого, и тому подобное.

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

На следующем рисунке показан пример пространства, из которого при экспорте формируются два документа: Техническое задание и Частное техническое задание. Пространство показано «под углом» варианта ТЗ, на что указывает иконка в правом верхнем углу. Слева в дереве пространства серым цветом обозначены те страницы, которые не принадлежат к выбранному варианту («Раздел для ЧТЗ», «Раздел для ЧТЗ 2»). К обоим документам относится раздел «Требования к системе»: данная иерархия страниц привязана к обоим вариантам. На странице требования указана метаинформация и блок описания, которые не попадут ни в один из документов при экспорте; далее идут блоки формулировок требования для ТЗ и ЧТЗ.

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 10 — Пример страницы требования, относящегося к нескольким документам

Для создания такой структуры нужно, во-первых, активировать возможность добавления вариантов в установках пространства и создать необходимые варианты документации (рис. 11):

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 11 — Создание вариантов документации на уровне пространства

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 12 — Пример шаблона требования

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

После этого при создании страницы данный шаблон можно будет выбрать наряду со стандартными (рис. 13).

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 13 — Создание страницы требования

Далее, необходимо создать страницы требований по шаблону, заполнив соответствующие поля и привязав страницы к созданным вариантам (рис. 14).

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 14 — Привязка страницы требования к вариантам

После этого на странице появится информация о том, что она привязана к указанным вариантам, а при наведении курсора мыши появится всплывающее окно, которое покажет, какие именно варианты задействованы (рис. 15).

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 15 — Сообщение о том, к каким вариантам привязана страница

Также при наведении курсора на блок текста, не привязанный к текущему варианту, будет выведено соответствующее сообщение (рис. 16).

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 16 — Сообщение о том, что контент не привязан к текущему варианту

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

Варианты можно использовать также для создания документации на разных языках.

Создание эксплуатационной документации для различных версий продукта

Кроме вариантов документации, Scroll versions позволяет создавать ее версии. Версионнсть также настраивается на уровне пространства.

Как и в случае вариантов, к версиям можно привязать отдельные страницы (отсутствующие в другой версии) и создавать различные версии одной и той же страницы. Главное отличие от вариантов состоит в том, что создается несколько модификаций одной и той же страницы с отдельным контентом и отдельной историей изменений. Очередная версия страницы создается на основе предыдущей.

Версии можно сравнивать между собой как на уровне страницы (рис. 17), так и на уровне пространства.

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 17 — Сравнение версий страницы

Привязка бизнес-процессов

Для отслеживания состояния проработки требования можно использовать плагин Comala Workflows, с помощью которого есть возможность настроить бизнес-процесс прохождения требования по определенным этапам (например, «в проработке», «на обсуждении», «на рецензии», «согласовано»). Можно задействовать один из стандартных бизнес-процессов, входящих в комплектацию, либо создать собственные. Здесь также можно настроить систему оповещений пользователей о переводе страниц на новый этап, а по состояниям бизнес-процесса формировать отчеты. Помимо этого, существует возможность писать комментарии и ставить задачи непосредственно при переводе страницы на новый этап. Например, при переходе к этапу «на рецензии», можно, упомянув ответственного пользователя, написать, на что именно ему следует обратить внимание.

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 18 — Переход к новому состоянию бизнес-процесса работы с требованием

Создание «динамических» отчетов

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 19 — Пример отчета

Импорт документов MS Word

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

Как сделать таблицу в confluence. Смотреть фото Как сделать таблицу в confluence. Смотреть картинку Как сделать таблицу в confluence. Картинка про Как сделать таблицу в confluence. Фото Как сделать таблицу в confluence

Рисунок 20 — Импорт документа: выбор уровня заголовка, заканчивая которым документ будет разделен на страницы Confluence

Еще несколько полезных плагинов

Заключение

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

Источник

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *