Канбан-диаграмма
Диаграмма канбан Mermaid позволяет создавать визуальное представление перехода задач по разным этапам рабочего процесса; ниже объясняется, как правильно использовать синтаксис диаграммы канбан.
Основы
Диаграмма канбан начинается с синтаксиса kanban, затем определяются столбцы и задачи в этих столбцах.
Копировать
Встраивание
kanban
column1[Column Title]
task1[Task Description]
Определение столбцов
Столбцы представляют различные этапы рабочего процесса, например «Todo», «In Progress», «Done» и т. д. Каждый столбец определяется уникальным идентификатором и заголовком, заключённым в квадратные скобки.
Синтаксис:
Копировать
Встраивание
columnId[Column Title]
- columnId: уникальный идентификатор столбца.
- [Column Title]: заголовок, отображаемый в верхней части столбца.
比如 id1[Todo]
Добавление задач в столбец
Задачи отображаются в соответствующих столбцах с отступом. Каждая задача включает уникальный идентификатор и описание, заключённое в квадратные скобки.
Синтаксис:
Копировать
Встраивание
taskId[Task Description]
taskId: уникальный идентификатор задачи.,[Task Description]: описание задачи.
Пример:
Копировать
Встраивание
docs[Create Documentation]
Добавление метаданных к задаче
Вы можете использовать синтаксис @{ ... } для добавления дополнительных метаданных к каждой задаче. Метаданные могут содержать пары ключ-значение, такие как assigned, ticket, priority и другие, которые будут отображаться при рендеринге узла.
Поддерживаемые ключи метаданных
assigned: указывает, кто отвечает за задачу.,ticket: связывает задачу с номером заявки или проблемы.,priority: обозначает степень срочности задачи. Допустимые значения: Very High, High, Low и Very Low.
Копировать
Встраивание
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Параметры конфигурации
Для настройки диаграммы канбан можно использовать блок конфигурации в начале markdown-файла. Это полезно для задания глобальных настроек (например, базового URL заявок). В настоящее время у диаграммы канбан <code>ticketBaseUrl</code> это очень полезно для задания глобальных настроек, например базового URL заявок. В настоящее время у диаграммы канбан есть один параметр конфигурации ticketBaseUrl. Можно задать его по следующему примеру:
Копировать
Встраивание
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
Когда у элемента канбана указан номер заявки, номер заявки на диаграмме будет содержать ссылку на внешнюю систему, в которой определена эта заявка. ticketBaseUrl задаёт базовый URL, указывающий на внешнюю систему, а #TICKET# заменяется значением заявки из метаданных задачи для создания действительной ссылки.
Полный пример
Ниже приведён пример полного кода диаграммы канбан:
Копировать
Встраивание
---
config:
kanban:
ticketBaseUrl: 'https://mermaidchart.atlassian.net/browse/#TICKET#'
---
kanban
Todo
[Create Documentation]
docs[Create Blog about the new diagram]
[In progress]
id6[Create renderer so that it works in all cases. We also add some extra text here for testing purposes. And some more just for the extra flare.]
id9[Ready for deploy]
id8[Design grammar]@{ assigned: 'knsv' }
id10[Ready for test]
id4[Create parsing tests]@{ ticket: MC-2038, assigned: 'K.Sveidqvist', priority: 'High' }
id66[last item]@{ priority: 'Very Low', assigned: 'knsv' }
id11[Done]
id5[define getData]
id2[Title of diagram is more than 100 chars when user duplicates diagram with 100 char]@{ ticket: MC-2036, priority: 'Very High'}
id3[Update DB function]@{ ticket: MC-2037, assigned: knsv, priority: 'High' }
id12[Can't reproduce]
id3[Weird flickering in Firefox]
Итак, создание диаграммы канбан в Mermaid — это простой процесс, позволяющий эффективно визуализировать ваш рабочий процесс.
Вы можете улучшить свою диаграмму, добавляя к задачам необязательные метаданные с помощью синтаксиса @{ ... }; этот синтаксис позволяет включать дополнительную контекстную информацию, например ответственного, номер заявки и приоритет. Для дальнейшей настройки используйте блок конфигурации в верхней части файла, чтобы задать глобальные параметры, например ticketBaseUrl, для ссылок на заявки непосредственно из диаграммы.
Следуя этим рекомендациям, обеспечивая уникальные идентификаторы, правильные отступы и используя метаданные и параметры конфигурации, вы можете создать всеобъемлющую и персонализированную диаграмму канбан, эффективно отражающую рабочий процесс проекта.
