リファレンスアーキテクチャは、Cloudflare 製品が顧客の既存インフラにどう収まるかを示し、ユースケースを Cloudflare のソリューションに対応付ける、高レベルの設計文書です。トーンは案内的で、率直にします。
このページでは書き方を扱います。公開済みのアーキテクチャ自体は Reference architectures を参照してください。
複数の Cloudflare 製品を組み合わせ、顧客の環境とユースケースにどう収まるかを設計レベルで示す必要があるときに、リファレンスアーキテクチャを書きます。これらの文書は通常、詳細です。次のものではありません。
- 概念（Concept）。 概念は 1 つの考えを深く説明します。リファレンスアーキテクチャは、複数の製品が実環境でどう組み合わさるかを示します。
- 手順（How to）。 リファレンスアーキテクチャは説明と設計であり、手順は書きません。
文章での説明がほとんど不要な単一のアーキテクチャには、代わりに リファレンスアーキテクチャ図 を使います。全体の比較は コンテンツタイプ を参照してください。公開例は Cloudflare Load Balancing Reference Architecture、Magic Transit Reference Architecture、Evolving to a SASE architecture with Cloudflare を参照してください。
- Title: アーキテクチャまたはソリューションを表す名詞句です。例: "Cloudflare Load Balancing Reference Architecture"。
- Description: ソリューションと製品を名付け、既存インフラへの収まり方と対象ユースケースを述べ、想定読者（IT およびセキュリティ担当者など）を示します。
このひな形をコピーし、対象のアーキテクチャに合わせて調整します。
---
title: <Noun phrase naming the architecture or solution>
description: How <products> fit <infrastructure> for <use case>, written for <the intended audience>.
pcx_content_type: reference-architecture
sidebar:
order: 10
products:
- product-a
---
Open with two or three paragraphs on the subject matter, then state who the document is for and what they will learn.
## <Architecture area>
Present the reference diagram with numbered callouts, and explain each element in prose so the meaning survives without the image.
## <Use case to solution>
Map the customer use case to the Cloudflare solution, and flag any caveats that affect how the architecture applies.
## Related links
Link the supporting how-tos, concepts, and product documentation with current routes.- 図 が中核コンポーネントです。1 枚のリファレンス図が全体アーキテクチャを表し、キャプションと番号付きコールアウトで各要素を説明します。補助図で特定の部分を掘り下げます。
- イントロダクションと想定読者 で文書を文章から始めます。主題を 2〜3 段落で書いたあと、対象者と学ぶ内容を示します。
- 注記と警告 で、アーキテクチャの適用に影響する注意点を示します。
- PublicStats は、アーキテクチャを支える材料になる場合に、Cloudflare ネットワークの統計を示します。
- 向かないもの: 手順です。リファレンスアーキテクチャは設計であり、操作手順ではありません。実装は How to へリンクします。
pcx_content_type: reference-architecture
products:
- product-a
- product-b詳細は pcx_content_type を参照してください。
リファレンスアーキテクチャ図は、より軽い形式です。番号付きコールアウト付きの 1 枚の図と、説明に必要な最小限の文章で、全文のアーキテクチャが不要なソリューション向けです。トーンは説明的で、率直にします。
- 使うタイミング: 1 枚の図でソリューションが伝わり、文章での説明がほとんど不要なときに使います。設計を詳しく論じる必要がある場合は、全文のリファレンスアーキテクチャを選びます。
- Title: 全文のリファレンスアーキテクチャと同じく、名詞句です。
- 構成: 1 枚のリファレンス図、各要素を説明する番号付きコールアウト、図が何に関係するかの短い説明、関連コンテンツへのリンクです。
- Frontmatter:
pcx_content_typeをreference-architecture-diagramにします。
- すべての図にテキスト相当を付ける。 番号付きコールアウトを文章で説明し、図にテキスト相当を付けます。エージェントは画像を読めないため、意味は画像なしでも成立する必要があります。
- 製品名とユースケース名を本文に書く。 正確な Cloudflare 製品名とユースケースを、図の中だけでなく本文にも書きます。アーキテクチャ単体で検索できるようにします。
- 根拠になるリンク。 関連する How to、概念、製品ドキュメントへ、現行の実在するルートでリンクします。アーキテクチャは実装へ外向きに案内します。