FAQ ページは、あるトピックのよくある質問と短い直接的な回答を集め、読者がひとつの事実へすぐたどり着けるようにし、プロダクトの見つけやすさを高めます。トーンは率直で、教育的で、権威あるものにします。
本当に「質問と直接の回答の一覧」であるページだけを FAQ にします。質問がおおよそ 10 件を超える場合は、一部の回答をドキュメントの別の場所へ移すべきか見直します。FAQ は次のものではありません。
- how-to やチュートリアル。 手順の質問は how-to またはチュートリアルに置き、FAQ ではよくあるものをいくつか取り上げて、そちらへ戻るリンクを置きます。
- 用語集。 定義の質問は用語集に置き、FAQ では必須で繰り返し出る定義だけを載せ、リンクで案内します。
- トラブルシューティングページ。 トラブルシューティングページはエラーとその修正をカタログ化し、FAQ はもっともよくある問題だけを質問として取り上げます。
全体の比較は コンテンツタイプ を参照してください。
- Title: ページタイトルは FAQ です。セクションが多い大規模な FAQ では、各子ページにそのセクション名を付けます。
- Description: プロダクト名と、質問が扱う主要なトピック領域を書きます。
このスケルトンをコピーし、トピックに合わせて調整します。
---
title: FAQ
description: Answers to common questions about <product>, covering <the key topic areas>.
pcx_content_type: faq
sidebar:
order: 10
products:
- product-a
---
Open with a short paragraph on the topic and what the reader can expect to find.
## <Question written in full from the reader's point of view>
Lead with the direct answer, add one or two sentences of context, and link to the how-to, tutorial, or glossary that answers it in full.
## <Next question>
Answer completely and link out to the source of truth.- Context は、トピックと読者が得られる内容を短い段落でページの冒頭に置きます。
- Navigation は、FAQ が大きくなりセクションが必要になったときに、その一覧を示し、読者が適切なグループへ飛べるようにします。
- Links は、取り上げた質問から、完全な回答がある how-to、チュートリアル、用語集エントリへ読者を案内します。
- 向かないもの: 長い手順や網羅的な定義です。それらは正規の how-to、チュートリアル、用語集に置き、リンクします。
pcx_content_type: faq
products:
- product-a
- product-b詳しくは pcx_content_type を参照してください。
各質問は、読者の視点で一人称を使い、全文で書きます。"Can users use wildcards when creating policies?" より "Can I use wildcards when creating policies?" を優先します。回答は完結させ、Yes / No で答えられる質問では、文脈を足す前に直接の答えを先に置きます。先頭の "Yes" を省いた回答より、"Yes. Cloudflare Access supports several providers simultaneously." を優先します。
ほとんどの質問は次の 5 種類のいずれかに当てはまり、それぞれ回答の形が決まっています。
| 種類 | 質問の形 | 答え方 |
|---|---|---|
| Yes/No | "Can I...", "Does the product..." | Yes または No を先に置き、続けて 1〜2 文の文脈を足します |
| 手順 | "How do I...", "How does it work?" | 簡潔に答え、その内容を扱う how-to またはチュートリアルへリンクします |
| 定義 | "What is...?" | 辞書のような短い定義を書き、用語集へリンクします |
| シナリオ | "What if...?" | 最初の文でプロダクトが合うかどうかを述べ、文脈を足し、リンクで案内します |
| トラブルシューティング | "I see...", "It does not work when..." | 理由を述べ、短い実行可能な手順を示し、より詳しいドキュメントへリンクします |
- 小さなページ（おおよそ 10 問まで）はセクション不要です。タイトル、文脈の段落、続けて質問と回答です。
- 中くらいのページ はセクション見出しと、それを列挙するナビゲーションメニューを足します。
- 大きな FAQ（Cloudflare One のようなプロダクトスイート向け）は、各セクションを子ページに分けます。メインページは各セクションを 1 行の文脈と各子ページへのボタンで列挙し、各子ページはそのセクションの質問を載せ、ランディングページへ戻るパンくずを付けます。
- 質問は全文で。 各質問は読者の視点で完全な文で書きます。エージェントは省略した見出しではなく、質問全体で照合します。
- 直接答える。 直接の答えを先に置き、Yes / No の質問では Yes または No を先に出します。読者もエージェントも、最初の文で事実を得られます。
- 信頼できる情報源へリンクする。 手順、定義、シナリオの回答は、すべて正規の how-to、チュートリアル、用語集エントリを指します。FAQ は近道であり、権威ではありません。