跳转到内容
搜索文档

链接

最后更新 查看 MarkdownAgent 设置

链接是指向另一个页面、页面的某一部分或外部资源的引用。

超链接非常有用,但如果使用过度,可能会分散注意力。

链接类型

共有 3 种类型的链接:

  • 外部(External):指向其他资源的链接,例如 www.cloudflare.com。
  • 内部(Internal):指向文档中其他页面的链接,例如 Workers
  • 锚点(Anchor):指向文档中其他页面特定部分的链接,例如 代理记录

行内段落链接指南

避免使用非描述性的链接文本,例如:click here(点击此处)和 this page(此页面);相反,应使用目标页面的实际标题或该标题的缩写版本。这也很重要,因为这能让读者看到,当他们到达那里时,他们实际上链接到了他们打算访问的页面。

使用唯一的链接文本。语音识别软件无法很好地处理重复的链接文本。

仅在链接是内部链接(Cloudflare 网站内的链接)且材料与所描述的内容直接相关时,才使用段落内链接。换句话说,链接背后的内容能否帮助读者在继续阅读当前文档之前做出决定或完成某些工作?

避免使用方向性语言。

相关资源章节的链接

在文档末尾使用“相关资源(Related resources)”部分,用于:

  • 与主题松散相关或提供更深入学习机会的内部链接
  • 所有外部链接(不属于 Cloudflare 网站的链接)
  • 代表下一步逻辑步骤的内部和外部链接

强烈不建议在段落中放置外部链接,因为 Cloudflare 无法控制这些链接。例如,如果某个链接失效,我们的内容就会显得不太可靠。通过将所有外部链接移至文档末尾,链接失效带来的影响将不那么显著。

交叉链接要求

相关页面之间的交叉链接构建了一个可导航的知识图谱。当 AI 系统遇到概念页面时,它可以顺着链接找到分步说明、排障指南或参考数据,并为用户的查询引用最相关的页面。搜索引擎使用相同的链接结构来理解主题关系。

每个带有 pcx_content_type 的页面都应在其相关资源(Related resources)部分包含指向相关页面的链接。使用下表确定从每个页面链接到哪些内容类型。

内容类型 必须链接到
概念 相关的操作指南或快速入门页面;相关的参考页面
操作指南 先决条件概念页面;相关的配置页面;问题排查页面
快速入门 更深层次的操作指南页面;产品概览页面
问题排查 相关的操作指南页面;相关的配置页面
配置 父级操作指南或快速入门页面;相关的概念页面
参考 相关的概念页面;使用该参考的操作指南页面
教程 相关产品概览;先决条件快速入门页面

链接应当是双向的。如果一个概念页面链接到某个操作指南,该操作指南也应当链接回该概念页面。这确保了用户(以及 AI 系统)可以在两个方向上在页面之间穿梭。

示例

关于 DNS 记录的概念页面应链接到相关的操作指南、问题排查和参考页面:

Related resources section on a concept pagemarkdown
## Related resources

- To create or modify DNS records, refer to [Manage DNS records](/dns/manage-dns-records/how-to/create-dns-records/).
- For common DNS issues, refer to [Troubleshoot DNS records](/dns/troubleshooting/).
- For a complete list of supported record types, refer to [DNS record types](/dns/manage-dns-records/reference/dns-record-types/).

对应的操作指南页面也应链接回去:

Related resources section on a how-to pagemarkdown
## Related resources

- To learn how DNS records work, refer to [DNS records](/dns/manage-dns-records/).
- For record type details, refer to [DNS record types](/dns/manage-dns-records/reference/dns-record-types/).
- For common DNS issues, refer to [Troubleshoot DNS records](/dns/troubleshooting/).

当链接不存在时

并非每种内容类型在表中的每一行都会有匹配的页面。链接到已有的页面。如果相关页面尚不存在,请勿创建占位符链接。相反,请考虑缺失的页面是否代表文档集中应当解决的空白。

文档中说明的链接

将示例请求和 API 调用的链接放在代码块中。

在具有账户或用户特定信息的链接中使用占位符。并解释用什么替换该引用文本。

  • 例如,对于链接 “https://api.cloudflare.com/client/v4/accounts/a0b1c2d3/rulesets”,使用 “https://api.cloudflare.com/client/v4/accounts/<ACCOUNTID>/rulesets” 并添加文本说明,如“将 <ACCOUNTID> 替换为您的 Account ID(账户 ID)”或类似说明。

请参见“代码约定和格式”中的尖括号

维护

有关我们如何处理链接维护的更多详细信息,请参考链接维护

这篇文档对您有帮助吗?