提及、引用和链接

有三种方式可以把您写的内容与架构的其余部分联系起来:

  • @提及会点名某个成员或团队,对方会在收件箱中收到通知;
  • #引用指向 C4 元素、决策或页面,被引用的一方会列出所有引用它的内容;
  • 指向 Archyl 页面的链接会在应用内和 Slack 中以预览形式打开。

可以在哪里使用

在项目中任何书写文字的地方,都可以输入 @ 和 #:

  • 讨论中和元素详情面板中的评论与回复;
  • 架构决策(ADR)的背景、决策和后果;
  • 文档页面;
  • 变更请求的描述,以及其中的评论和评审。

提及

输入 @ 并开始输入名字。列表会显示能够打开该项目的成员,以及至少包含其中一人的团队。用方向键和 Enter 选择,或用鼠标点击。

  • 名字会写入文本,保存后显示为高亮的标签。
  • 您提及的每个人都会在收件箱中收到通知:“Ada 在一项决策中提到了你”“Ada 在变更请求 #12 中提到了你”等。团队则会通知到其中能够打开该项目的成员。
  • 每个人只会收到一次通知:再次编辑文本时,已经被提及的人不会再收到通知。
  • 您永远不会因为提及自己而收到通知。

标题中的提及不会被识别;请写在正文中。

引用

输入 # 并开始输入。列表会显示项目中包含的内容:

  • 系统、容器、组件和代码元素,每一项都带有其父级;
  • 决策,以 ADR-3 的形式列出并附带标题;
  • 文档页面。

引用会变成一个标签。点击它即可打开被引用的内容:元素会在架构图中其所在的层级打开,并且已处于选中状态;决策或页面会在各自的页面打开。

被引用于

所有可以被引用的内容都会列出它在哪里被引用,最新的排在最前:

  • 元素:在其详情面板的 被引用于 部分;
  • 决策:在其展开卡片的底部;
  • 页面:在页面底部。

每一行显示引用处前后的摘录,并可打开其来源:评论会打开所在的讨论,评审会打开所在的变更请求。

来自代理(MCP)

通过 MCP 服务器连接的代理也可以提及和引用。当代理撰写评论、ADR、文档页面或变更请求时:

  • @Name 会提及某个成员或团队,规则和通知与应用内相同。代理通过 list_mentionables 工具获取准确的名字。
  • #Label 会引用元素、决策(#ADR-3)或页面,被引用的一方会在 被引用于 中列出代理的文字。
  • 代理发表的评论还会通知已在讨论中的成员,以及关注该元素的人。

每次写入都会返回已关联的内容,因此代理可以确认其提及是否送达了正确的人。get_backlinks 工具会返回元素、决策或页面在哪里被引用,让代理在修改某项内容之前知道有谁在讨论它。

链接和预览

复制链接

使用 复制链接 获取可分享的链接:

  • 在元素详情面板中,位于关闭按钮旁边:链接会在元素所在的层级打开它,并处于选中状态;
  • 在决策卡片上;
  • 在文档页面顶部。

变更请求和讨论可以通过地址栏分享。

Archyl 中的预览

粘贴在评论、变更请求描述或评审中的 Archyl 页面链接,会以卡片形式显示在文字下方:标题、类型和状态、所属项目以及一段摘录。点击卡片即可打开该页面,无需重新加载应用。每条消息最多预览三个链接。

只有能够打开该内容所属项目的人才能看到预览。对其他人来说,链接仍然是普通链接。

Slack 中的预览

安装 Slack 机器人后,在 Slack 中发布的 Archyl 链接会展开为同样的预览。规则和设置请参阅 Slack 中的链接预览。