Skip to content

Как работать с Confluence?

Проблема: информация разбросана по Confluence

  • По мере развития проекта, за сервисы или domain могли отвечать разные команды и подразделения, поэтому информация может находиться в разных Confluence Spaces.
  • Следует найти всю документацию связанную с сервисом или domain и переместить в одно родительскую страницу. Для этого следует использовать поиск в Confluence.
  • В случае если нет прав на перемещение, то запросить такие права или найти лиц (владельцев или администраторов), которые смогут переместить данные страницы в подконтрольный Space.
  • При перемещении, Confluence сохраняет навигацию и старые ссылки приведут к нужному контенту.

Проблема: документация неактуальна

  • Стоит собрать всю документацию в одну родительскую страницу, которая и будет являться источником правды.
  • Пересмотреть документацию на актуальность (можно смотреть на историю изменений и просмотров).
    • Если страница актуальна, то дать понятное название для данной страницы.
    • Если страница частично актуальна, то удалить все ненужное (история ведь сохраняется).
    • Если страница не актуальна, то дать название с префиксом TO_DELETE: и постфиксом с датой удаление страницы. В качестве даты удаление стоит использовать дату не ранее 3-х месяцев от текущей, что бы заинтересованные лица успели уведомить о ее актуальности.

Проблема: дублирование информации

Местонахождение терминов из глоссария, аббревиатур, страниц определяется методом всплытия: если используется и на уровне выше (например: находится на уровне team, но используется и в unit/cluster), то перемещается на уровень выше.

Проблема: не актуальные ссылки

Не делать прямых ссылок на страницы, которые находятся не под управлением team/unit/cluster. Для этого на странице "Полезные ссылки" добавить ссылку в таблицу и создать для нее уникальный идентификатор, на который и ссылаться. Это позволяет избавиться от "протухших" и дублирующих ссылок.

Проблема: отсутствует информация

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