ドキュメントの各ページにはコンテンツタイプがあります。含める内容、構成、保守の仕方を決めた型です。適切なタイプを選ぶと、読者とエージェントにとってページの形が予測しやすくなります。新しい製品には必ず Overview と Get started のページが必要です。それ以外のタイプは、読者が何を必要とするかで決まります。
このページでは、タイプを役割ごとに分けています。混同しやすいタイプを見分けられます。各タイプの詳しい指針は、表内のページを参照してください。
読者が何かをやり遂げるためのタイプです。
| コンテンツタイプ | 選ぶとき |
|---|---|
| How to | 読者はすでに製品を選んでおり、その中で 1 つの具体的な作業を完了する必要があります。 |
| Tutorial | 読者は実際のプロジェクトを最初から最後まで作りながら学びます。過程そのものが、結果と同じくらい学びになります。 |
| Get started | 新規利用者が、何もない状態から最初の動作結果まで、最短で進む必要があります。 |
| 3rd-party integration guide | 読者が特定の外部製品を 1 つ Cloudflare とつなぎ、そのガイドの保守を約束する場合です。 |
| Configuration | 機能の設定項目が多く、読者に必要なのは手順よりも設定と値である場合です。 |
読者が理解する、または探し出すためのタイプです。
| コンテンツタイプ | 選ぶとき |
|---|---|
| Concept | 読者が、対象が何であり、なぜその動きになるかを理解する必要があります。 |
| Reference | 読者が、すべてのパラメーター、値、オプションなど、中立で漏れのない詳細を調べる必要があります。 |
| Overview | 初めての読者が、先へ進む前に、製品領域を 1 段落で把握する必要があります。 |
| FAQ | よくある質問のそれぞれに、短い直接の答えと、情報源へのリンクが必要です。 |
| Troubleshooting | 読者が特定のエラーや症状に直面し、原因と対処が必要です。 |
実装ではなく、ソリューションを設計するためのタイプです。
| コンテンツタイプ | 選ぶとき |
|---|---|
| Reference architecture | 設計レベルで、複数の製品がお客様の環境とユースケースにどう合うかを示します。 |
| Design guide | 読者が特定のソリューション 1 つと、その背後にあるアーキテクチャ上の判断を、構築前に計画します。 |
読者を次へ案内する、または変更を記録するためのタイプです。
| コンテンツタイプ | 選ぶとき |
|---|---|
| Navigation | 配下のページが多く、読者に案内付きの入口が必要な領域です。 |
| Changelog | 製品の注目すべき変更を、日付付きで記録します。 |