メンション、引用、リンク

書いた内容をアーキテクチャの他の部分とつなぐ方法は 3 つあります。

  • @メンションは、ユーザーまたはチームを名指しし、その相手の受信トレイに通知します。
  • #引用は、C4 要素、意思決定、ページを指し示し、引用された側には引用しているものがすべて一覧表示されます。
  • Archyl のページへのリンクは、アプリ内と Slack でプレビューとして表示されます。

使える場所

プロジェクト内でテキストを書く場所ならどこでも、@ と # を入力できます。

  • ディスカッションや要素の詳細パネルでのコメントと返信
  • アーキテクチャ意思決定(ADR)のコンテキスト、決定、結果
  • ドキュメントページ
  • 変更リクエストの説明、そのコメントとレビュー

メンション

@ を入力して、名前を入力し始めます。一覧には、プロジェクトを開けるユーザーと、そのようなユーザーを 1 人以上含むチームが表示されます。矢印キーと Enter、またはマウスで選択します。

  • 名前がテキストに挿入され、保存後はハイライトされたチップとして表示されます。
  • メンションした全員の受信トレイに通知されます。たとえば「Ada さんが決定であなたをメンションしました」「Ada さんが変更リクエスト #12 であなたをメンションしました」などです。チームの場合は、プロジェクトを開けるメンバーに届きます。
  • 通知は 1 回だけです。テキストを再度編集しても、すでにメンションされている人には通知されません。
  • 自分自身へのメンションで通知されることはありません。

タイトル内のメンションは検出されません。本文に書いてください。

引用

# を入力して、入力し始めます。一覧には、プロジェクトに含まれるものが表示されます。

  • システム、コンテナ、コンポーネント、コード要素(それぞれ親要素付き)
  • 意思決定(ADR-3 の形式でタイトル付き)
  • ドキュメントページ

引用はチップになります。クリックすると引用先が開きます。要素はダイアグラムのそれぞれのレベルで、選択された状態で開きます。意思決定やページはそれぞれのページで開きます。

引用元

引用できるものはすべて、どこで引用されているかを新しい順に一覧表示します。

  • 要素の場合は、詳細パネルの 引用元 セクション
  • 意思決定の場合は、展開したカードの下部
  • ページの場合は、ページの下部

各行には引用箇所周辺の抜粋が表示され、クリックすると引用元が開きます。コメントならそのディスカッション、レビューならその変更リクエストです。

エージェントから(MCP)

MCP サーバー経由で接続したエージェントも、メンションと引用ができます。エージェントがコメント、ADR、ドキュメントページ、変更リクエストを書くとき、次のように動作します。

  • @Name はユーザーまたはチームをメンションします。ルールと通知はアプリ内と同じです。エージェントは list_mentionables ツールで正確な名前を取得します。
  • #Label は要素、意思決定(#ADR-3)、ページを引用し、引用された側の 引用元 にエージェントのテキストが一覧表示されます。
  • エージェントのコメントは、すでにディスカッションに参加しているユーザーと、その要素のフォロワーにも通知されます。

書き込みのたびにリンクされた内容が返されるので、エージェントはメンションが正しい相手に届いたかを確認できます。get_backlinks ツールは、要素、意思決定、ページがどこで引用されているかを返します。これにより、エージェントは変更する前に、誰がそれについて議論しているかを把握できます。

リンクとプレビュー

リンクをコピーする

共有用のリンクを取得するには リンクをコピー を使います。

  • 要素の詳細パネルでは、閉じるボタンの横にあります。リンクを開くと、要素がそのレベルで選択された状態で開きます。
  • 意思決定のカード
  • ドキュメントページの上部

変更リクエストとディスカッションは、アドレスバーから共有できます。

Archyl 内のプレビュー

コメント、変更リクエストの説明、レビューに貼り付けた Archyl のページへのリンクは、テキストの下にカードとして表示されます。カードには、タイトル、種類とステータス、プロジェクト、抜粋が表示されます。カードをクリックすると、アプリを再読み込みせずにそのページが開きます。1 つのメッセージでプレビューされるリンクは最大 3 件です。

プレビューは、そのコンテンツが属するプロジェクトを開けるユーザーにだけ表示されます。それ以外のユーザーには、通常のリンクのまま表示されます。

Slack でのプレビュー

Slack ボットがインストールされている場合、Slack に投稿された Archyl へのリンクは同じプレビューに展開されます。ルールと設定については Slack でのリンクプレビューをご覧ください。