デザインガイドは、読者が Cloudflare で特定のソリューションを計画・設計できるよう案内します。設定に入る前に、そのソリューションの背後にあるアーキテクチャ上の判断に焦点を当てます。デザインガイドは リファレンスアーキテクチャ の、対象を絞った一部です。トーンは指導的で率直にします。
読者が 1 つの特定ソリューションのアーキテクチャを計画し、構築前に判断とトレードオフを理解する必要があるときに、デザインガイドを書きます。次のものではありません。
- リファレンスアーキテクチャ。 リファレンスアーキテクチャは製品横断の広いアーキテクチャを説明します。デザインガイドは、その中の 1 つの特定ソリューションの計画に絞ります。
- how-to。 how-to は製品を設定する手順を示します。デザインガイドは、設定を始める前にアーキテクチャ上の判断とトレードオフを考えます。
全体の比較は コンテンツタイプ を参照してください。
- タイトル: 動名詞ではなく、二人称の命令形の短い動詞句にします。"Securely delivering applications" より "Securely deliver applications with Cloudflare" を優先します。
- 説明: 読者が計画・設計するソリューション、関わる Cloudflare 製品、扱うアーキテクチャ上の判断を名前で示します。
次のスケルトンをコピーし、ソリューションに合わせて直します。
---
title: <Verb phrase naming the solution to plan>
description: Plan and design <solution> with <Cloudflare products>, covering <the architecture decisions>.
pcx_content_type: design-guide
sidebar:
order: 10
products:
- product-a
---
Open with two or three paragraphs describing the subject matter and the end state of the solution.
## Intended audience
Summarize who the guide is for and what they will learn.
## <Architecture decision or design area>
Describe the design and the decisions and trade-offs behind it, include a diagram of the architecture, and link out to the how-tos and tutorials that implement it.
## Related links
Point to the reference architecture and product documentation the design draws on.- 導入 は、対象とガイドが詳述するソリューションの完成形を、2〜3 段落で開きます。
- 想定読者 は、ガイドの対象者と学べる内容を要約します。
- 図表 はアーキテクチャを示します。デザインガイドの中心です。
- 注記と警告 は、設計の当てはめ方に影響する注意点とトレードオフを示します。
- 関連リンク は、設計の根拠となるリファレンスアーキテクチャと製品ドキュメントを指します。
- 向かないもの: 手順どおりの設定。デザインガイドはソリューションを計画するので、実装する how-to とチュートリアルへリンクします。
pcx_content_type: design-guide
products:
- product-a
- product-b詳細は pcx_content_type を参照してください。
- 設計であり、手順ではありません。 アーキテクチャとその判断を説明し、実装する how-to とチュートリアルへリンクします。デザインガイドはエージェントが推論する計画であり、実行する手順ではありません。
- 完成形を先に示します。 ガイドが作る完成ソリューションを冒頭で説明します。読者やエージェントが設計を追う前に目標を把握できます。
- 読者と前提を明示します。 ガイドの対象者と前提とするインフラを述べます。デザインガイドは、適切な文脈を持つ読者にだけ実行可能です。