Программная документация в Confluence

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

Система Confluence – результат деятельности австралийской компании Atlassian, создающей ПО для управления разработкой ПО. Известность компании принесли два продукта: Jira и Confluence. Первый продукт обеспечивает управление проектами на любой стадии разработки, а второй – нацелен на обмен специалистами важной информацией по проекту.

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

• структурированность интерфейса;

• персонализацию;

• возможность совместной работы;

• удобство администрирования;

• ленту новостей, блоги и права доступа;

• безопасность и защиту данных;

• интеграцию;

• универсальность и простоту пользования;

• доступность;

• масштабирование;

• вариативность размещения.

Принципы работы в Confluence

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

В процессе создания пространства необходимо определить права доступа к информации (глобальный уровень, уровень пространства или уровень страницы). Удобнее разделить всех зарегистрированных пользователей на группы по принадлежности к проекту и присвоить права доступа на уровне групп. По умолчанию в программе заложены три группы пользователей: системные администраторы, администраторы Confluence и confluence-users. Первые обладают полным спектром прав доступа; вторые имеют возможность осуществлять все администраторские функции, которые не нарушают безопасность системы. Confluence-users – это группа для любого нового пользователя. В третью группу пользователь попадает по умолчанию.

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

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

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

Какие инструменты Confluence могут быть полезны в процессе разработки программной документации?

• создание Пространства документации (выбор шаблона пространства, подходящего для размещения программных документов);

• повторное использование контента (возможность переноса раздела документа или документа полностью с одной страницы на другую);

• создание шаблонов страниц (упрощает процесс разработки программной документации для схожих продуктов);

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

• использование ссылок и анкоров (возможность ссылаться с одной страницы на другую);

• применение полезных макросов («Оглавление», «Подсказка», «Информация», «Предупреждение», «Примечание», «Панель» и др.);

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

• экспорт PDF (упрощает дальнейшую отправку документа на почту или печать).

Наша команда подготовит для вас программную документацию в Confluence. Специалисты создадут пространство для документов и настроят права доступа для пользователей. Результатом нашей работы будет удобная база для документации на программное обеспечение с инструментами совместной работы.