Mermaid ドキュメント

Appearance

Mermaid カンバンダイアグラムのドキュメント ​

Mermaidのカンバンダイアグラムを使用すると、ワークフローの異なる段階を移動するタスクの視覚的表現を作成できます。このガイドでは、提供された例に基づいてカンバンダイアグラムの構文の使用方法を説明します。

概要 ​

Mermaidのカンバンダイアグラムは、kanbanキーワードで始まり、列（段階）とその列内のタスクの定義が続きます。

Code:
mermaid
kanban
  column1[列のタイトル]
    task1[タスクの説明]

列の定義 ​

列は、ワークフロー内の異なる段階（「Todo」、「進行中」、「完了」など）を表します。各列は、一意の識別子と角括弧で囲まれたタイトルを使用して定義されます。

構文:

columnId[列のタイトル]
  • columnId: 列の一意の識別子。

このように id1[Todo]

列へのタスクの追加 ​

タスクは、適切な列の下にインデントを付けてリスト表示されます。各タスクには、一意の識別子と角括弧で囲まれた説明があります。

構文:

taskId[タスクの説明]
•	taskId: タスクの一意の識別子。
•	[タスクの説明]: タスクの説明。

例:

docs[ドキュメントの作成]

タスクへのメタデータの追加 ​

各タスクに追加のメタデータを含めることができます。これは、@{ ... } 構文を使用します。メタデータには、assigned、ticket、priorityなどのキーと値のペアを含めることができます。これは、ノードのレンダリングに追加されます。

サポートされているメタデータキー ​

•	assigned: タスクの責任者を指定します。
•	ticket: タスクをチケットまたは問題番号にリンクします。
•	priority: タスクの緊急性を示します。許可されている値: '非常に高い'、'高い'、'低い'、および '非常に低い'
Code:
mermaid
kanban
todo[Todo]
  id3[データベース機能の更新]@{ ticket: MC-2037, assigned: 'knsv', priority: '高' }

設定オプション ​

Markdownファイルの冒頭に設定ブロックを使用してカンバンダイアグラムをカスタマイズできます。これにより、チケットのベースURLなど、グローバル設定を設定できます。現在のところ、カンバンダイアグラムの設定オプションは1つ ticketBaseUrl です。以下の例のように設定できます。

yaml
---
config:
  kanban:
    ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---

カンバンアイテムに割り当てられたチケット番号がある場合、ダイアグラム内のチケット番号は、このチケットが定義されている外部システムへのリンクを持ちます。ticketBaseUrl は外部システムへのベースURLを設定し、#TICKET#はタスクメタデータからのチケット値に置き換えられ、有効なリンクを作成します。

完全な例 ​

以下は、提供された例に基づく完全なカンバンダイアグラムです。

Code:
mermaid
---
config:
  kanban:
    ticketBaseUrl: 'https://mermaidchart.atlassian.net/browse/#TICKET#'
---
kanban
  Todo
    [ドキュメントの作成]
    docs[新しいダイアグラムについてのブログを作成]
  [進行中]
    id6[すべてのケースで動作するレンダラーを作成します。テスト目的で追加のテキストをいくつか加えます。さらなるフレアのためにいくつか追加します。]
  id9[デプロイの準備完了]
    id8[文法の設計]@{ assigned: 'knsv' }
  id10[テストの準備完了]
    id4[解析テストの作成]@{ ticket: MC-2038, assigned: 'K.Sveidqvist', priority: '高' }
    id66[最後の項目]@{ priority: '非常に低い', assigned: 'knsv' }
  id11[完了]
    id5[データ取得の定義]
    id2[ユーザーが100文字のダイアグラムを複製すると、ダイアグラムのタイトルが100文字を超える]@{ ticket: MC-2036, priority: '非常に高い'}
    id3[DB機能の更新]@{ ticket: MC-2037, assigned: knsv, priority: '高' }

  id12[再現できません]
    id3[Firefoxでの奇妙な点滅]

結論として、Mermaidでカンバンダイアグラムを作成するのは簡単なプロセスであり、あなたのワークフローを効果的に視覚化します。まずはkanbanキーワードを使用してダイアグラムを開始します。次に、ユニークな識別子とタイトルを使用して段階を表すために列を定義します。各列の下に、ユニークな識別子を持つタスクをリストアップし、必要に応じて詳細な説明を提供します。適切なインデントが重要であることを忘れずに。タスクは、正しい構造を維持するために親列の下にインデントされている必要があります。

@{ ... }構文を使用してタスクにオプションのメタデータを追加することで、アサイン、チケット番号、優先度などの追加のコンテキストを含めることができます。さらなるカスタマイズのために、ファイルの先頭にある設定ブロックを活用して、チケットをダイアグラムから直接リンクするためのticketBaseUrlなどのグローバルオプションを設定してください。

これらのガイドラインに従うことで—ユニークな識別子、適切なインデントを確保し、メタデータと設定オプションを活用して—Mermaidを使用してプロジェクトのワークフローを効果的にマッピングする包括的でカスタマイズ可能なカンバンボードを作成できます。