リンク
クリック、タップ、または選択することでアクセスできるデータへの参照。
すべてのコンテンツタイプ
ハイパーリンクはオンラインコンテンツで非常に便利ですが、過剰に使用すべきではありません。段落内での過剰なハイパーリンクはしばしば気を散らし、読者の焦点を現在の作品から逸らす可能性があります。
「ここをクリック」や「このページ」のような非記述的なリンクテキストは避け、代わりにターゲットページの実際のタイトルまたはそのタイトルの略称を使用してください。これは、読者がそこに到達したときに、実際に訪問したいページにリンクされていることを確認するためにも重要です。
ユニークなリンクテキストを使用してください。音声認識ソフトウェアは、重複したリンクテキストをうまく処理できません。
インパラグラフリンクは、内部リンク（Cloudflareのウェブサイト内のもの）であり、かつその資料が説明されている内容に直接関連している場合にのみ使用してください。言い換えれば、リンクの背後にあるコンテンツは、読者が現在の文書を読み続ける前に決定を下したり、何かを達成するのに役立つでしょうか？
方向性の言語は避けてください。
文書の最後に関連リソースセクションを使用して、以下を提供します：
- トピックに loosely 関連する内部リンクや、より深い学習の機会を提供するリンク
- すべての外部リンク（Cloudflareのウェブサイトに存在しないもの）
- 次の論理的なステップを示す内部および外部リンク
段落内に配置された外部リンクは強く推奨されません。なぜなら、Cloudflareはそれらを制御できないからです。たとえば、リンクがもはや解決しない場合、私たちのコンテンツは信頼性が低く感じられます。すべての外部リンクを文書の最後に移動することで、壊れたリンクの影響は少なくなります。
例のリクエストやAPIコールのリンクはコードブロック内に配置してください。
アカウントまたはユーザー固有の情報を含むリンクにはプレースホルダーを使用し、参照テキストを何に置き換えるべきかを説明してください。
- たとえば、リンク “
https://api.cloudflare.com/client/v4/accounts/a0b1c2d3/rulesets” の場合、“https://api.cloudflare.com/client/v4/accounts/<ACCOUNTID>/rulesets” を使用し、「<ACCOUNTID>をあなたのアカウントIDに置き換えてください」といったテキストを追加します。
コード規約とフォーマットの角括弧を参照してください。