Menzioni, citazioni e link

Tre modi per collegare ciò che scrivi al resto della tua architettura:

  • le @menzioni nominano una persona o un team, che vengono avvisati nella loro inbox;
  • le #citazioni puntano a un elemento C4, a una decisione o a una pagina, che elenca tutto ciò che la cita;
  • i link alle pagine di Archyl si aprono come anteprima, nell'app e in Slack.

Dove puoi usarle

Puoi digitare @ e # ovunque si scriva del testo in un progetto:

  • commenti e risposte, nelle discussioni e nel pannello dei dettagli di un elemento;
  • il contesto, la decisione e le conseguenze di una decisione architetturale (ADR);
  • le pagine di documentazione;
  • le descrizioni delle richieste di modifica, i loro commenti e le loro revisioni.

Menzioni

Digita @ e inizia a scrivere un nome. L'elenco mostra le persone che possono aprire il progetto e i team che ne contano almeno una. Scegline una con le frecce e Enter, oppure con il mouse.

  • Il nome viene scritto nel testo e, una volta salvato, appare come un'etichetta evidenziata.
  • Ogni persona che menzioni viene avvisata nella sua inbox: "Ada ti ha menzionato in una decisione", "nella richiesta di modifica #12" e così via. Un team raggiunge i suoi membri che possono aprire il progetto.
  • Ognuno viene avvisato una sola volta: modificare di nuovo il testo non avvisa chi era già menzionato.
  • Non ricevi mai notifiche per una tua menzione.

Le menzioni in un titolo non vengono rilevate; scrivile nel corpo del testo.

Citazioni

Digita # e inizia a scrivere. L'elenco mostra ciò che il progetto contiene:

  • i suoi sistemi, container, componenti ed elementi di codice, ciascuno con il proprio genitore;
  • le sue decisioni, elencate come ADR-3 con il loro titolo;
  • le sue pagine di documentazione.

La citazione diventa un'etichetta. Facendo clic si apre ciò che cita: un elemento si apre nel diagramma al proprio livello, già selezionato; una decisione o una pagina si apre nella sua pagina.

Citato in

Tutto ciò che può essere citato elenca dove è citato, dal più recente:

  • un elemento, nella sezione Citato in del suo pannello dei dettagli;
  • una decisione, in fondo alla sua scheda espansa;
  • una pagina, in fondo alla pagina.

Ogni riga mostra l'estratto intorno alla citazione e apre la sua origine: la discussione di un commento, la richiesta di modifica di una revisione.

Dagli agenti (MCP)

Anche gli agenti collegati tramite il server MCP possono menzionare e citare. Quando un agente scrive un commento, un ADR, una pagina di documentazione o una richiesta di modifica:

  • @Name menziona una persona o un team, con le stesse regole e notifiche dell'app. L'agente ottiene i nomi esatti dallo strumento list_mentionables.
  • #Label cita un elemento, una decisione (#ADR-3) o una pagina, che elenca il testo dell'agente sotto Citato in.
  • Un commento di un agente avvisa anche le persone già presenti nella discussione e chi segue l'elemento.

Ogni scrittura restituisce ciò che è stato collegato, così l'agente può verificare che le sue menzioni abbiano raggiunto le persone giuste. Lo strumento get_backlinks restituisce dove un elemento, una decisione o una pagina è citato, e indica a un agente chi ne sta discutendo prima che lo modifichi.

Link e anteprime

Copiare un link

Usa Copia link per ottenere un link da condividere:

  • nel pannello dei dettagli di un elemento, accanto al pulsante di chiusura: il link apre l'elemento al suo livello, selezionato;
  • su una scheda di decisione;
  • in cima a una pagina di documentazione.

Le richieste di modifica e le discussioni si condividono dalla barra degli indirizzi.

Anteprime in Archyl

Un link a una pagina di Archyl incollato in un commento, nella descrizione di una richiesta di modifica o in una revisione appare come una scheda sotto il testo: il titolo, il tipo e lo stato, il progetto e un estratto. Facendo clic sulla scheda la pagina si apre senza ricaricare l'app. Per ogni messaggio vengono mostrate al massimo tre anteprime.

Un'anteprima viene mostrata solo a chi può aprire il progetto a cui appartiene il contenuto. Per tutti gli altri il link resta un link semplice.

Anteprime in Slack

Quando il bot Slack è installato, i link ad Archyl pubblicati in Slack si espandono nella stessa anteprima. Vedi Anteprime dei link in Slack per le regole e la configurazione.