让链接文字说明目的地
把目标页名称、术语或动作写进原句,在这些词语上添加链接。单独读链接文字时,读者应能判断点击后会看到什么。链接外的文字用于交代何时打开、打开后要做什么。
| 原句 | 改写 |
|---|---|
| 点击这里了解如何确定读者。 | 写教程前先确定读者的起点,再列出准备工作。 |
| 请阅读更多内容了解版本范围。 | 发布前在升级指南中核对起始版本。 |
| 语言规则见下文。 | 用机构和产品名称的写法统一正文和示例中的拼写。 |
中文句末标点留在链接之外。链接到下载文件时,可在文字中写明文件类型或大小。确实要复制网址时,把网址当作输入值放进代码,例如 https://example.com/docs。
选择页面地址和版本
在本指南中,跨页链接使用 /docs/…,同页链接使用 #锚点。其他项目遵循各自的路由和语言前缀。链接到原文时,方法签名、默认值和升级说明应使用对应版本。引用仓库中的固定代码时,可以链接到特定提交的文件或行。
链接到更长页面的一部分时,把地址定位到读者要用的小节。标题中的符号或代码可能被渲染器转换,锚点也会因同名标题而增加后缀。先预览页面,再从标题链接复制实际地址。
验证链接上下文
- 从页面中实际打开链接,确认页面和标题均能找到。
- 核对链接文字与目标页的语言、版本和任务一致。
- 修改路径或标题后,搜索正文、导航和共享片段中的旧引用。
读者可能保存了具体段落的地址。调整章节时,可以按旧地址处理方式核对页路径和标题锚点。