Menções, citações e links

Três formas de ligar o que você escreve ao resto da sua arquitetura:

  • as @menções nomeiam uma pessoa ou uma equipe, que é avisada na caixa de entrada;
  • as #citações apontam para um elemento C4, uma decisão ou uma página, que lista tudo o que a cita;
  • os links para páginas do Archyl abrem como prévias, no aplicativo e no Slack.

Onde usar

Você pode digitar @ e # em qualquer lugar onde se escreve texto em um projeto:

  • comentários e respostas, nas discussões e no painel de detalhes de um elemento;
  • o contexto, a decisão e as consequências de uma decisão de arquitetura (ADR);
  • as páginas de documentação;
  • as descrições das solicitações de mudança, seus comentários e revisões.

Menções

Digite @ e comece a digitar um nome. A lista mostra as pessoas que podem abrir o projeto e as equipes que têm pelo menos uma delas. Escolha uma com as setas e Enter, ou com o mouse.

  • O nome é escrito no texto e, depois de salvo, aparece como um chip destacado.
  • Todos que você menciona são avisados na caixa de entrada: "Ada mencionou você em uma decisão", "na solicitação de mudança #12" e assim por diante. Uma equipe alcança seus membros que podem abrir o projeto.
  • Cada pessoa é avisada uma única vez: editar o texto de novo não notifica quem já foi mencionado.
  • Você nunca é notificado da sua própria menção.

Menções em um título não são detectadas; escreva-as no corpo.

Citações

Digite # e comece a digitar. A lista mostra o que o projeto contém:

  • seus sistemas, contêineres, componentes e elementos de código, cada um com o seu pai;
  • suas decisões, listadas como ADR-3 com o título;
  • suas páginas de documentação.

A citação vira um chip. Clicar nele abre o que ele cita: um elemento abre no diagrama no próprio nível, já selecionado; uma decisão ou uma página abre na sua página.

Citado em

Tudo o que pode ser citado lista onde é citado, do mais recente ao mais antigo:

  • um elemento, na seção Citado em do painel de detalhes;
  • uma decisão, no fim do card expandido;
  • uma página, no fim da página.

Cada linha mostra o trecho em volta da citação e abre a sua origem: a discussão de um comentário, a solicitação de mudança de uma revisão.

A partir de agentes (MCP)

Agentes conectados pelo servidor MCP também podem mencionar e citar. Quando um agente escreve um comentário, um ADR, uma página de documentação ou uma solicitação de mudança:

  • @Name menciona uma pessoa ou uma equipe, com as mesmas regras e notificações do aplicativo. O agente obtém os nomes exatos com a ferramenta list_mentionables.
  • #Label cita um elemento, uma decisão (#ADR-3) ou uma página, que lista o texto do agente em Citado em.
  • Um comentário de um agente também avisa as pessoas que já estão na discussão e quem segue o elemento.

Cada escrita retorna o que foi vinculado, para que o agente possa conferir se as menções chegaram às pessoas certas. A ferramenta get_backlinks retorna onde um elemento, uma decisão ou uma página é citado, o que mostra a um agente quem discute algo antes de alterá-lo.

Links e prévias

Copiar um link

Use Copiar link para obter um link para compartilhar:

  • no painel de detalhes de um elemento, ao lado do botão de fechar: o link abre o elemento no seu nível, selecionado;
  • em um card de decisão;
  • no topo de uma página de documentação.

Solicitações de mudança e discussões podem ser compartilhadas pela barra de endereço.

Prévias no Archyl

Um link para uma página do Archyl colado em um comentário, na descrição de uma solicitação de mudança ou em uma revisão aparece como um card abaixo do texto: o título, o tipo e o status, o projeto e um trecho. Clicar no card abre a página sem recarregar o aplicativo. Até três links ganham prévia por mensagem.

A prévia só aparece para quem pode abrir o projeto ao qual o conteúdo pertence. Para todos os outros, o link continua sendo um link simples.

Prévias no Slack

Quando o bot do Slack está instalado, os links para o Archyl postados no Slack se expandem na mesma prévia. Veja Prévias de links no Slack para as regras e a configuração.