リンクは、別のページ、ページ内の箇所、または外部リソースへの参照です。ハイパーリンクは便利ですが、多すぎると読者の注意をそらします。リンクテキストと配置は、次の指針に従ってください。
リンクには 3 種類あります。
- 外部: ほかのリソースへのリンクです。例: www.cloudflare.com ↗
- 内部: ドキュメント内のほかのページへのリンクです。例: Workers
- アンカー: ドキュメント内のほかのページの特定箇所へのリンクです。例: プロキシ済みレコード
リンクを作るときは、製品へのパスを使います。
- する:
This is a link for Cloudflare WAN's [Get started](/cloudflare-wan/get-started/)
- しない:
This is a link for Cloudflare WAN's [Get started](https://developers.cloudflare.com/cloudflare-wan/get-started/)
次も非対応です:
- 相対リンク:
A link to [`DurableObjectNamespace::get`](./namespace) - リンクにファイル拡張子を使う:
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 ダッシュボードへ案内するときは、次の決まりを使います。
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 セクションに関連ページへのリンクを入れてください。各ページからどのコンテンツタイプへリンクするかを、次の表で決めます。
| コンテンツタイプ | リンク先(必須) |
|---|---|
| Concept | 関連する How to またははじめにページ。関連する Reference ページ |
| How-to | 前提となる Concept ページ。関連する Configuration ページ。Troubleshooting ページ |
| Get started | 次の段階の How to ページ。製品の概要ページ |
| Troubleshooting | 関連する How to ページ。関連する Configuration ページ |
| Configuration | 親の How to またははじめにページ。関連する Concept ページ |
| Reference | 関連する Concept ページ。そのリファレンスを使う How to ページ |
| Tutorial | 関連する製品概要。前提となるはじめにページ |
リンクは双方向にします。Concept ページが How to へリンクするなら、How to からも Concept へ戻るリンクを置きます。ユーザー(と AI システム)がどちら向きにもページをたどれるようにします。
DNS レコードのコンセプトページは、関連する How to、トラブルシューティング、リファレンスへリンクします。
## 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/).対応する How to ページからは、次のように戻します。
## 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 に置き換える」などと書きます。
コードの表記と書式の 山括弧 を参照してください。
リンク保守の詳細は リンクの保守 を参照してください。