Skip to content

FAQ

Last updated View as MarkdownAgent setup

An FAQ page collects common questions on a topic with short, direct answers, giving a reader a fast path to a single fact and improving the discoverability of the product. The tone is straightforward, educational, and authoritative.

When to use it

Write an FAQ only when a page is genuinely a list of questions with direct answers. If the list grows beyond roughly 10 questions, revisit whether some answers belong elsewhere in the documentation. It is not:

  • A how-to or tutorial. Procedural questions belong in a how-to or tutorial, whereas an FAQ calls out only a few common ones and links back to them.
  • A glossary. Definition questions belong in the glossary, whereas an FAQ repeats only the essential, recurring definitions and links out.
  • A troubleshooting page. A troubleshooting page catalogs errors and their fixes, whereas an FAQ surfaces only the most common issues as questions.

For the full comparison, refer to Content types.

Title & description

  • Title: the page title is FAQ. In a large multi-section FAQ, each child page takes the name of its section instead.
  • Description: name the product and the key topic areas the questions cover.

Scaffold this page

Copy this skeleton and adapt it to your topic:

---
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.

Component guidance

  • Context opens the page with a short paragraph on the topic and what the reader can expect to find.
  • Navigation lists the sections once an FAQ is large enough to need them, so a reader can jump to the right group.
  • Links carry the reader from a called-out question to the how-to, tutorial, or glossary entry that answers it in full.
  • What does not fit: long procedures or exhaustive definitions. Keep those in their canonical how-to, tutorial, or glossary and link to them.

Frontmatter

pcx_content_type: faq
products:
  - product-a
  - product-b

For more details, refer to pcx_content_type.

Writing questions and answers

Write each question in full and from the reader's point of view, using the first person. Prefer "Can I use wildcards when creating policies?" over "Can users use wildcards when creating policies?". Answer completely, and when the question is phrased as yes or no, lead with the direct response before adding context. Prefer "Yes. Cloudflare Access supports several providers simultaneously." over an answer that omits the leading "Yes".

Question types

Most questions fall into one of five types, each with its own answer shape:

Type Question shape How to answer
Yes/No "Can I...", "Does the product..." Lead with Yes or No, then one or two sentences of context
Procedural "How do I...", "How does it work?" Give a concise answer, then link to the how-to or tutorial that covers it
Definition "What is...?" Give a short, dictionary-style definition, then link to the glossary
Scenario "What if...?" Say whether the product fits in the first sentence, add context, link out
Troubleshooting "I see...", "It does not work when..." Give the reason, then short actionable steps, then link to deeper docs

Structuring larger FAQs

  • Small pages, up to about 10 questions, need no sections: a title, a context paragraph, then the questions and answers.
  • Medium pages add section headings and a navigation menu that lists them.
  • Large FAQs, for product suites such as Cloudflare One, split each section onto its own child page: the main page lists the sections with a one-line context and a button to each child page, and each child page carries its section's questions under breadcrumbs back to the landing page.

Writing for AI and agents

  • Full question text. Write each question with its complete text from the reader's point of view, because an agent matches on the whole question, not a truncated heading.
  • Direct answers. Lead with the direct response, Yes or No where the question is yes/no, so a reader or agent gets the fact in the first sentence.
  • Link to the source of truth. Point every procedural, definition, or scenario answer to its canonical how-to, tutorial, or glossary entry, because the FAQ is a shortcut, not the authority.

Was this helpful?