Mermaid カンバン図ドキュメント
Mermaidのカンバン図を使用すると、ワークフローのさまざまな段階を経るタスクを視覚的に表現できます。このガイドでは、提供されている例に基づいて、カンバン図の構文の使用方法を説明します。
概要
Mermaidのカンバン図は、kanbanキーワードで始まり、その後に列（ステージ）とそれらの列内のタスクの定義が続きます。
列の定義
列は、「ToDo」、「進行中」、「完了」など、ワークフローのさまざまな段階を表します。各列は、一意の識別子と角かっこで囲まれたタイトルを使用して定義されます。
構文
columnId[Column Title]- columnId：列の一意の識別子。
- [列のタイトル]：列ヘッダーに表示されるタイトル。
例： id1[Todo]
列へのタスクの追加
タスクは、それぞれの列の下にインデントされてリストされます。各タスクには、一意の識別子と角かっこで囲まれた説明もあります。
構文
taskId[Task Description]• taskId: A unique identifier for the task.
• [Task Description]: The description of the task.例
docs[Create Documentation]タスクへのメタデータの追加
@{ ... } 構文を使用して、各タスクに追加のメタデータを含めることができます。メタデータには、担当者、チケット、優先度などのキーと値のペアを含めることができます。これは、ノードのレンダリングに追加されてレンダリングされます。
サポートされているメタデータキー
• assigned: Specifies who is responsible for the task.
• ticket: Links the task to a ticket or issue number.
• priority: Indicates the urgency of the task. Allowed values: 'Very High', 'High', 'Low' and 'Very Low'設定オプション
Markdownファイルの先頭に設定ブロックを使用して、カンバン図をカスタマイズできます。これは、チケットのベースURLなどのグローバル設定を設定するのに役立ちます。現在、カンバン図の設定オプションは tacketBaseUrl です。これは、次の例のように設定できます。
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---カンバンアイテムに割り当てられたチケット番号がある場合、図のチケット番号には、チケットが定義されている外部システムへのリンクが設定されます。 `ticketBaseUrl` は外部システムへのベースURLを設定し、#TICKET# はタスクメタデータからのチケット値に置き換えられて、有効なリンクが作成されます。
完全な例
以下は、提供されている例に基づく完全なカンバン図です。
結論として、Mermaidでカンバン図を作成することは、ワークフローを効果的に視覚化する簡単なプロセスです。 kanbanキーワードを使用して図を開始します。プロジェクトのさまざまな段階を表すために、列を一意の識別子とタイトルで定義します。各列の下に、タスク（これも一意の識別子付き）をリストし、必要に応じて詳細な説明を提供します。適切なインデントが重要であることに注意してください。正しい構造を維持するために、タスクは親列の下にインデントする必要があります。
@{ ... } 構文を使用してタスクにオプションのメタデータを追加することで、図を強化できます。これにより、担当者、チケット番号、優先度レベルなどの追加のコンテキストを含めることができます。さらにカスタマイズするには、ファイルの先頭にある設定ブロックを使用して、図からチケットを直接リンクするための ticketBaseUrl などのグローバルオプションを設定します。
これらのガイドライン（一意の識別子、適切なインデント、メタデータと設定オプションの利用）に従うことで、Mermaidを使用してプロジェクトのワークフローを効果的にマッピングする、包括的でカスタマイズされたカンバンボードを作成できます。