Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

3rd-party integration guide

最終更新 Markdown で表示Agent セットアップ

サードパーティ連携ガイドは、サードパーティ製品を Cloudflare と一緒に使う方法を説明します。Cloudflare は第三者のインターフェイスを管理していないため、これらのガイドには保守リスクがあります。そのため、別製品の手順を再現するより、外部で保守されているドキュメントへのリンクを優先します。トーンは手順的で、率直にします。

使うタイミング

読者が特定の外部製品 1 つを Cloudflare と接続する必要があり、継続的な保守の意思を持って公開する価値があるときに、サードパーティ連携ガイドを書きます。次のものではありません。

  • How to。 How to は Cloudflare 内だけで完結する作業を説明します。連携ガイドは、Cloudflare が管理しないサードパーティ製品に踏み込みます。
  • ブログ記事。 連携ガイドは保守する前提でのみ公開します。保守するつもりがなければ、代わりにブログ記事を書いてください。

全体の比較は コンテンツタイプ を参照してください。

タイトルと説明

  • タイトル: サードパーティ製品名を含む、二人称の命令形による短い動詞句にします。動名詞は使いません。Cloudflare のテクノロジーパートナーとの連携である場合は、タイトルのあとにパートナーの要素を足します。
  • 説明: サードパーティ製品と Cloudflare 製品を挙げ、連携で達成することを述べ、重要な前提条件に触れます。

このページのひな形

このスケルトンをコピーし、連携内容に合わせて調整します。

---
title: <Verb phrase naming the third-party product>
description: Connect <third-party product> with <Cloudflare product> to <what the integration accomplishes>.
pcx_content_type: integration-guide
sidebar:
  order: 10
products:
  - product-a
---

Introduce what the integration accomplishes and any considerations unique to the third party.

## Prerequisites

List what the reader needs on the third-party side before starting.

## Set up the integration

Give the steps that complete the integration, linking to the third party's own documentation rather than reproducing its process.

## Related links

Point to the third party's maintained documentation and the related Cloudflare product docs.

コンポーネントの指針

  • Context は、手順で達成することと、第三者固有の考慮事項を紹介します。
  • Prerequisites は、開始前に第三者側で必要なものを列挙します。
  • Steps は連携を完了します。基本概念は教えず、リンクします。
  • Links は第三者自身のドキュメントを指します。手順の再現よりこちらを優先し、信頼できるソースにだけリンクします。
  • 当てはまらないもの: サードパーティ製品の手順そのものです。第三者側が変わった瞬間に古くなるため、推奨しません。サードパーティ製品のスクリーンショットは最も壊れやすいので避け、外部で保守されているソースへリンクします。

frontmatter

pcx_content_type: integration-guide
products:
  - product-a
  - product-b

詳細は pcx_content_type を参照してください。

保守と範囲

連携ガイドは販売後の利用フェーズ向けとして公開し、だれかが保守する前提にします。Cloudflare は第三者のインターフェイスを管理せず、変更の可視性も同じではないため、外部ガイドの保守コストは高くなります。その保守を約束せずに公開したい場合は、代わりにブログ記事を書いてください。このコンテンツは WorkersZero TrustAnalytics の連携まわりでよく登場します。

事例

Cloudflare ダッシュボード内で完結する連携:

外部ドキュメントへリンクする連携:

サードパーティ環境と Cloudflare ダッシュボードの両方に手順がある連携です。推奨しませんが、場合によっては許容されます。

AI とエージェント向けの書き方

  • 再現せず、リンクします。 第三者側の手順は、第三者自身のドキュメントを指してください。再現した手順やスクリーンショットは、外部製品が変わった瞬間に古くなります。
  • 前提条件を漏れなく書きます。 開始前に第三者側で必要なものを正確に述べてください。セットアップできていない連携は、エージェントも完了できません。
  • 両方の製品名を書きます。 タイトルと文脈にサードパーティ製品と Cloudflare 製品を書いてください。読者やエージェントが、必要な連携にガイドを結びつけられます。

役に立ちましたか?