Erwähnungen, Zitate und Links

Drei Wege, das, was Sie schreiben, mit dem Rest Ihrer Architektur zu verbinden:

  • @Erwähnungen nennen eine Person oder ein Team, die in ihrem Posteingang benachrichtigt werden;
  • #Zitate verweisen auf ein C4-Element, eine Entscheidung oder eine Seite, die alles auflistet, was sie zitiert;
  • Links zu Archyl-Seiten öffnen sich als Vorschau, in der App und in Slack.

Wo Sie sie verwenden können

Sie können @ und # überall dort tippen, wo in einem Projekt Text geschrieben wird:

  • in Kommentaren und Antworten, in Diskussionen und im Detailbereich eines Elements;
  • im Kontext, in der Entscheidung und in den Konsequenzen einer Architekturentscheidung (ADR);
  • auf Dokumentationsseiten;
  • in den Beschreibungen von Änderungsanträgen, ihren Kommentaren und Reviews.

Erwähnungen

Tippen Sie @ und beginnen Sie, einen Namen einzugeben. Die Liste zeigt die Personen, die das Projekt öffnen können, und die Teams, zu denen mindestens eine von ihnen gehört. Wählen Sie mit den Pfeiltasten und Enter oder mit der Maus.

  • Der Name wird in den Text eingefügt und nach dem Speichern als hervorgehobener Chip angezeigt.
  • Alle, die Sie erwähnen, werden in ihrem Posteingang benachrichtigt: „Ada hat Sie in einer Entscheidung erwähnt“, „im Änderungsantrag #12“ und so weiter. Ein Team erreicht seine Mitglieder, die das Projekt öffnen können.
  • Personen werden einmal benachrichtigt: Wenn Sie den Text erneut bearbeiten, werden bereits Erwähnte nicht noch einmal benachrichtigt.
  • Über Ihre eigene Erwähnung werden Sie nie benachrichtigt.

Erwähnungen in einem Titel werden nicht erkannt; schreiben Sie sie in den Haupttext.

Zitate

Tippen Sie # und beginnen Sie zu schreiben. Die Liste zeigt, was das Projekt enthält:

  • seine Systeme, Container, Komponenten und Code-Elemente, jeweils mit ihrem übergeordneten Element;
  • seine Entscheidungen, aufgeführt als ADR-3 mit ihrem Titel;
  • seine Dokumentationsseiten.

Das Zitat wird zu einem Chip. Ein Klick darauf öffnet, was es zitiert: Ein Element öffnet sich im Diagramm auf seiner eigenen Ebene und ist bereits ausgewählt; eine Entscheidung oder eine Seite öffnet sich auf ihrer Seite.

Zitiert in

Alles, was zitiert werden kann, listet auf, wo es zitiert wird, das Neueste zuerst:

  • ein Element im Abschnitt Zitiert in seines Detailbereichs;
  • eine Entscheidung unten auf ihrer aufgeklappten Karte;
  • eine Seite unten auf der Seite.

Jede Zeile zeigt den Auszug rund um das Zitat und öffnet seine Quelle: die Diskussion eines Kommentars, den Änderungsantrag eines Reviews.

Von Agenten (MCP)

Agenten, die über den MCP-Server verbunden sind, können ebenfalls erwähnen und zitieren. Wenn ein Agent einen Kommentar, einen ADR, eine Dokumentationsseite oder einen Änderungsantrag schreibt:

  • @Name erwähnt eine Person oder ein Team, mit denselben Regeln und Benachrichtigungen wie in der App. Der Agent erhält die genauen Namen über das Tool list_mentionables.
  • #Label zitiert ein Element, eine Entscheidung (#ADR-3) oder eine Seite, die den Text des Agenten unter Zitiert in auflistet.
  • Ein Kommentar eines Agenten benachrichtigt außerdem die Personen, die bereits an der Diskussion beteiligt sind, und alle, die dem Element folgen.

Jeder Schreibvorgang gibt zurück, was verknüpft wurde, damit der Agent prüfen kann, ob seine Erwähnungen die richtigen Personen erreicht haben. Das Tool get_backlinks liefert, wo ein Element, eine Entscheidung oder eine Seite zitiert wird, und zeigt einem Agenten so, wer darüber diskutiert, bevor er es ändert.

Links und Vorschauen

Einen Link kopieren

Verwenden Sie Link kopieren, um einen Link zum Teilen zu erhalten:

  • im Detailbereich eines Elements, neben der Schließen-Schaltfläche: Der Link öffnet das Element auf seiner Ebene, ausgewählt;
  • auf der Karte einer Entscheidung;
  • oben auf einer Dokumentationsseite.

Änderungsanträge und Diskussionen teilen Sie über die Adressleiste.

Vorschauen in Archyl

Ein Link zu einer Archyl-Seite, der in einen Kommentar, die Beschreibung eines Änderungsantrags oder ein Review eingefügt wird, erscheint als Karte unter dem Text: der Titel, sein Typ und Status, das Projekt und ein Auszug. Ein Klick auf die Karte öffnet die Seite, ohne die App neu zu laden. Pro Nachricht werden bis zu drei Links als Vorschau angezeigt.

Eine Vorschau sehen nur Personen, die das Projekt öffnen können, zu dem der Inhalt gehört. Für alle anderen bleibt der Link ein einfacher Link.

Vorschauen in Slack

Wenn der Slack-Bot installiert ist, werden Links zu Archyl, die in Slack gepostet werden, zur selben Vorschau entfaltet. Die Regeln und die Einrichtung finden Sie unter Link-Vorschauen in Slack.