ユーザーフロー - Archyl Docs

アーキテクチャ全体のインタラクションのシーケンスを可視化するユーザーフローとデータフローのドキュメント化

ユーザーフロー

Archylのユーザーフローでは、アーキテクチャ全体のインタラクションのシーケンスをドキュメント化できます。ユーザー、データ、またはリクエストがシステムを通じてどのように移動するかを可視化します。

フローとは?

フローはアーキテクチャを通じた一連のステップを表します:

  • ユーザージャーニー: ログイン、チェックアウト、サインアップ
  • データフロー: 注文処理、データ同期
  • システムインタラクション: API呼び出し、イベントチェーン
  • エラーハンドリング: 障害シナリオ、リトライ

フローの各ステップはアーキテクチャのリレーションシップを参照し、物事がどのように機能するかの接続されたビューを作成します。

フローの作成

フロータブから

  1. プロジェクトのフロータブに移動
  2. フローを作成をクリック
  3. 名前と説明を入力
  4. リレーションシップを選択してステップを追加
  5. 保存をクリック

フロー構造

各フローには以下が含まれます:

フィールド 説明
名前 短くわかりやすい名前(例: 「ユーザーログインフロー」)
説明 このフローが何を表すか
ステップ リレーションシップ参照の順序付きリスト

ステップの追加

各ステップについて:

  1. アーキテクチャからリレーションシップを選択
  2. ステップにソース、ターゲット、リレーションシップラベルが表示される
  3. ドラッグしてステップを並び替え
  4. 追加のコンテキスト用にメモを追加

AI でフローを生成

Archyl がフローを書いてくれます。ドキュメント化したいジャーニーを記述すると、AI が組織内のプロジェクトを読み、関係するプロジェクトを選び、ステップを生成します。

仕組み

ジェネレーターは 2 つのパスで動作します:

  1. プロジェクトのショートリスト — AI は組織内のすべてのプロジェクトをスキャンし、プロンプトに合致する最大 5 件を選択します。
  2. フローのステップ — AI はそれらのプロジェクトの統合された C4 モデル(プロジェクト間の関係を含む)を読み込み、順序付けられたステップのリストを書きます。

各ステップは永続化の前に C4 モデルに対して検証されます。存在しない要素や矛盾する関係を参照するステップは自動的に破棄されます。

フローを生成する

  1. サイドバーから Flows を開く
  2. Generate with AI をクリック
  3. 生成したいフローを記述する — プロンプトは必須
  4. Generate → をクリック

結果は自動的に開きます。複数のプロジェクトにまたがるフローには、リスト上に Cross-project バッジが付きます。

必要条件

  • 組織内に少なくとも 1 つのプロジェクトに C4 モデルが必要です(先に AI Discovery を実行してください)
  • プロンプトは必須です — プロジェクトのショートリストを駆動します
  • この機能は Business プラン で利用可能です

良いプロンプトのコツ

プロンプトが具体的であるほど、結果が精度の高いものになります。

あまり具体的でない より具体的
「ログイン」 「認証ジャーニー」
「メール」 「チェックアウト後に注文確認メールが送信される仕組み」
「データ」 「データ取り込みからダッシュボードまでのデータパイプライン」

具体性により、選択されるプロジェクト数が減り、編集なしで出荷できるステップが生成されます。

フローの表示

ステップバイステップナビゲーション

フローを表示する際:

  • ステップが順番に表示
  • 現在のステップがダイアグラム上でハイライト
  • 次へ/前へボタンでナビゲーション
  • 各ステップで完全なコンテキストを確認

アニメーション再生

再生をクリックしてフローをアニメーション:

  • 自動的なステップ進行
  • ダイアグラム上のハイライトされたパス
  • 調整可能な再生速度

フローの共有

パブリックフローリンク

ユーザーフローにはパブリック共有機能が組み込まれています:

  1. フローを開く
  2. 共有アイコンをクリック
  3. パブリックURLをコピー
  4. 誰にでも共有

パブリックビューには以下が含まれます:

  • ステップバイステップナビゲーション
  • アーキテクチャの可視化
  • フローの説明
  • 認証不要

フローの埋め込み

外部ツールにフローを埋め込み:

  • Confluence
  • Notion
  • ドキュメントサイト
  • Wiki

ベストプラクティス

わかりやすい名前を付ける

アクション指向の名前を使用:

  • 「ユーザー登録」
  • 「注文チェックアウトプロセス」
  • 「支払い返金フロー」
  • 「データ同期パイプライン」

フローを集中させる

  • ユーザージャーニーごとに1つのフロー
  • 5〜15ステップが理想的
  • 複雑なフローはサブフローに分割
  • 必要に応じて他のフローを参照

コンテキストを追加

説明で以下を説明:

  • なぜこのフローが存在するか
  • 誰が使用するか
  • いつトリガーされるか
  • 期待される結果は何か

ドキュメントにリンク

関連ドキュメントを参照:

  • API仕様
  • 要件ドキュメント
  • 設計選択を説明するADR

フローの例

ECサイトのチェックアウト

  1. ユーザー → カートサービス: 「カートを表示」
  2. カートサービス → 在庫: 「在庫確認」
  3. ユーザー → チェックアウトサービス: 「チェックアウト開始」
  4. チェックアウトサービス → 決済: 「支払い処理」
  5. 決済 → 注文サービス: 「注文作成」
  6. 注文サービス → 通知: 「確認メール送信」

API認証

  1. クライアント → APIゲートウェイ: 「資格情報付きリクエスト」
  2. APIゲートウェイ → 認証サービス: 「トークン検証」
  3. 認証サービス → ユーザーDB: 「ユーザー検索」
  4. 認証サービス → APIゲートウェイ: 「クレーム返却」
  5. APIゲートウェイ → バックエンド: 「ユーザーコンテキスト付き転送」

次のステップ