Какие знаешь макросы в Confluence?
Комментарии (1)
Ответ сгенерирован нейросетью и может содержать ошибки
Какие знаешь макросы в Confluence?
Макросы Confluence (Confluence Macros) — это встроенные элементы динамического контента, которые автоматически генерируют или форматируют информацию на странице. Для System Analyst макросы критичны при документировании архитектуры, требований и процессов.
Категория 1: Макросы структуры и оформления
Panel / Panel List
Оформляет содержимое в выделенный блок:
{panel:title=Important|borderColor=#ff5630|bgColor=#fff7d6}
This is critical information
{panel}
Использование: warnings, notes, выделение ключевых моментов
Status / Badge
Показывает статус:
{status:color=Green|title=Approved}
{status:color=Red|title=On Hold}
{status:color=Yellow|title=In Progress}
Использование: отслеживание статуса features, задач
Section / Column
Делит страницу на колонки:
{section}
{column:width=50%}
Left content
{column}
{column:width=50%}
Right content
{column}
{section}
Использование: сравнение вариантов, параллельные процессы
Table of Contents
Автоматически генерирует оглавление:
{toc:outline=true|minLevel=1|maxLevel=3}
Использование: навигация по документу (System Requirements, Architecture)
Категория 2: Макросы информации из системы
Jira Issue / Jira Report
Вставляет информацию из Jira:
{jira:url=https://jira.company.com/browse/PROJ-123}
{jira-issues:url=https://jira|maxResults=10|project=PROJ}
Использование: связь requirements с Jira issues
Page List / Child Pages
Показывает дочерние страницы:
{page-list:root=Architecture}
Использование: навигация по структуре документации
Bread Crumb
Показывает путь в иерархии:
{breadcrumbs}
Использование: навигация (автоматическое отображение пути)
Contributors / Page Properties
Показывает информацию о странице:
{contributors}
Использование: отслеживание, кто обновлял документацию
Категория 3: Макросы для диаграмм и визуализации
Mermaid / PlantUML
Текстовые диаграммы (требует плагина):
{mermaid}
graph TD
A[Requirement] --> B[Design]
B --> C[Implementation]
C --> D[Testing]
{mermaid}
Использование: архитектурные диаграммы, flowcharts
Gliffy / Draw.io Diagram
Диаграммы (встроенные редакторы):
{gliffy|name=Architecture|inline=true}
Использование: сложные диаграммы, системные чертежи
Категория 4: Макросы для кода
Code Block
Вставка кода с синтаксис-хайлайтингом:
{code:java|title=Example|theme=Emacs}
if (isValid) {
process(data);
}
{code}
Использование: примеры кода, скрипты, query'ес
Code Macro with SQL
{code:sql|title=Database Query}
SELECT user_id, COUNT(*) as orders
FROM orders
GROUP BY user_id;
{code}
Gist / GitHub Snippet
Вставляет код из GitHub:
{gist|id=your-gist-id}
Использование: актуальный код, примеры
Категория 5: Макросы для отслеживания
Change History
Показывает историю изменений:
{change-history|only-current-contributor=true}
Использование: версионирование документации
Recently Updated
Показывает недавно обновленные страницы:
{recently-updated:spaces=SPACE|max=10|days=30}
Использование: новости команды, свежая информация
Label / Tag Cloud
Показывает теги:
{label-cloud:max=20|spaces=SPACE}
Использование: категоризация документации
Категория 6: Макросы для интеграции
Embed Video / YouTube
{html}
<iframe width="560" height="315" src="https://www.youtube.com/embed/..."></iframe>
{html}
Использование: обучающие видео, демо
Embed HTML
{html}
<script src="..."></script>
{html}
Использование: интерактивные элементы
REST API Macro
Получает данные из API (требует плагина):
{rest:method=GET|path=/api/v1/users|limit=10}
Использование: динамические данные, статистика
Категория 7: Макросы для проектов и процессов
Team Calendar
Показывает календарь:
{team-calendar|project=PROJ}
Использование: планирование спринтов, встреч
Roadmap / Timeline
{roadmap|start=2025-01-01|end=2025-12-31}
Использование: планы развития, milestones
Approval / Decision
{approval:title=Architecture Decision|assignee=Team Lead}
Использование: согласование решений
Практические примеры для System Analyst
Пример 1: Документ Requirements
{toc:outline=true}
{status:color=Green|title=Latest Version: v2.3}
h2. Функциональные требования
{jira-issues|project=PROJ|assignee=currentUser()}
h2. Нефункциональные требования
{panel:title=Performance|bgColor=#deebff}
- P95 response: <= 200ms
- Throughput: >= 1000 RPS
{panel}
h2. Архитектура
{gliffy:name=System Architecture}
h2. История изменений
{change-history}
Пример 2: Architecture Decision Record
{panel:title=Decision|bgColor=#e3fcef|borderColor=#00875a}
**Decision:** Использовать Kafka вместо RabbitMQ
**Approved By:** Architecture Review Board
**Date:** 2025-03-28
{panel}
{section}
{column:width=50%}
h3. Pros
* Better throughput
* Replay capability
{column}
{column:width=50%}
h3. Cons
* Higher complexity
* More operations
{column}
{section}
{code:sql}
-- Migration plan from RabbitMQ
{code}
Пример 3: API Documentation
{panel:title=API Endpoint|bgColor=#fff7d6}
**GET** /api/v1/users/{id}
{panel}
**Parameters:**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| id | UUID | Yes | User identifier |
| include | string | No | Related resources (profile, settings) |
**Response (200 OK):**
{code:json}
{
"id": "uuid-123",
"name": "John Doe",
"email": "john@example.com"
}
{code}
Best Practices
1. Используй Status для отслеживания
{status:color=Green|title=Complete}
{status:color=Yellow|title=In Progress}
{status:color=Red|title=Blocked}
2. Структурируй с помощью Panels
{panel:title=Important|borderColor=#ff5630|bgColor=#fff7d6}
Content
{panel}
3. Добавляй Table of Contents для больших документов
{toc|maxLevel=3}
4. Ссылайся на Jira issues для отслеживания
{jira:url=https://jira.company.com/browse/PROJ-123}
5. Используй Code Blocks для примеров
{code:language|title=Example}
Content
{code}
6. Документируй решения с Approval
{approval|title=Architecture Decision}
7. Версионируй с Change History
{change-history}
Советы
- Confluence Cloud vs Server — макросы могут отличаться
- Плагины — для расширенных макросов может потребоваться плагин
- Live Editing — некоторые макросы обновляются в реальном времени
- Search — объекты в макросах могут быть индексированы для поиска
Макросы Confluence делают документацию живой, связанной и актуальной. Для System Analyst это must-have навык для эффективного управления документацией и коммуникацией с team.