链接是指向其他页面、页面某部分或外部资源的引用。超链接很有用,但使用过多会分散读者注意力。请遵循以下有关链接文字和位置的指南。
共有 3 种类型的链接:
- 外部(External):指向其他资源的链接,例如 www.cloudflare.com。 ↗
- 内部(Internal):指向文档中其他页面的链接,例如 Workers。
- 锚点(Anchor):指向文档中其他页面特定部分的链接,例如 代理记录。
创建链接时使用产品的路径。
- 应该:
This is a link for Cloudflare WAN's [Get started](/cloudflare-wan/get-started/)
- 不推荐(Don't):
This is a link for Cloudflare WAN's [Get started](https://developers.cloudflare.com/cloudflare-wan/get-started/)
同样不支持:
- Relative links:
A link to [`DurableObjectNamespace::get`](./namespace) - Using the file extension in links:
This is a link for Cloudflare WAN's [Get started](/cloudflare-wan/get-started.mdx/)
尽可能使用遵循以下模式之一的文本:
For more information, refer to [<PAGE_TITLE>](LINK).To <DO_SOMETHING>, refer to [<SECTION_TITLE>](LINK).
不要使用以下结构:
Learn more about...To read more....For more information, refer the [Merge requests](LINK) page.For more information, refer the [Merge requests](LINK) documentation.
链接文本的描述性越强,用户就越容易在您的网站中进行导航,Google 也越容易理解您所链接的内容。
实际上,这意味着您应该避免使用如 here、this page 或 read more 之类的链接文本。
例如,不要使用:
For more information, refer to [this page](LINK).For more information, go [here](LINK).
而是使用:
For more information, refer to [set up Cloudflare](LINK).
对于段落内的链接,还应遵循以下指南:
- 使用目标页面的实际标题或其缩写,帮助读者确认自己到达了预期页面。
- 使用唯一的链接文本。语音识别软件无法很好地处理重复的链接文本。
- 只有当段落中的链接指向 Cloudflare 网站内部,且链接内容与所述内容直接相关时,才使用段落内链接。请考虑读者在继续阅读前,链接内容是否有助于做出决定或完成任务。
- 避免使用方向性语言。
当引导用户访问 Cloudflare 仪表板(dashboard)时,请使用以下约定:
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
2. Go to **DNS** > **Records**.在文档末尾使用“相关资源(Related resources)”部分,用于:
- 与主题松散相关或提供更深入学习机会的内部链接
- 所有外部链接(不属于 Cloudflare 网站的链接)
- 代表下一步逻辑步骤的内部和外部链接
强烈不建议在段落中放置外部链接,因为 Cloudflare 无法控制这些链接。例如,如果某个链接失效,我们的内容就会显得不太可靠。通过将所有外部链接移至文档末尾,链接失效带来的影响将不那么显著。
相关页面之间的交叉链接构建了一个可导航的知识图谱。当 AI 系统遇到概念页面时,它可以顺着链接找到分步说明、排障指南或参考数据,并为用户的查询引用最相关的页面。搜索引擎使用相同的链接结构来理解主题关系。
每个带有 pcx_content_type 的页面都应在其相关资源(Related resources)部分包含指向相关页面的链接。使用下表确定从每个页面链接到哪些内容类型。
| 内容类型 | 必须链接到 |
|---|---|
| 概念 | 相关的操作指南或快速入门页面;相关的参考页面 |
| 操作指南 | 先决条件概念页面;相关的配置页面;问题排查页面 |
| 快速入门 | 更深层次的操作指南页面;产品概览页面 |
| 问题排查 | 相关的操作指南页面;相关的配置页面 |
| 配置 | 父级操作指南或快速入门页面;相关的概念页面 |
| 参考 | 相关的概念页面;使用该参考的操作指南页面 |
| 教程 | 相关产品概览;先决条件快速入门页面 |
链接应当是双向的。如果一个概念页面链接到某个操作指南,该操作指南也应当链接回该概念页面。这确保了用户(以及 AI 系统)可以在两个方向上在页面之间穿梭。
关于 DNS 记录的概念页面应链接到相关的操作指南、问题排查和参考页面:
## 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
- 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)”或类似说明。
请参阅“代码约定和格式”中的尖括号。
有关我们如何处理链接维护的更多详细信息,请参考链接维护。