FAQ 页面汇集某一主题的常见问题及简短、直接的回答,让读者能快速找到单一事实,并提升产品的可发现性。语气为直截了当、具有教育意义、权威性。
只有当页面确实是带有直接回答的问题列表时,才编写 FAQ。如果列表大约超过 10 个问题,请重新审视其中一些回答是否应放在文档的其他位置。它不是:
- 如何操作或教程。 程序性问题属于如何操作或教程,而 FAQ 只点出少数常见问题并链回去。
- 词汇表。 定义类问题属于词汇表,而 FAQ 只重复必要的、反复出现的定义并给出外链。
- 故障排除页面。 故障排除页面编目错误及其修复方法,而 FAQ 只把最常见的问题以问题形式呈现。
完整比较请参阅内容类型。
- 标题:页面标题为 FAQ。在大型多章节 FAQ 中,每个子页面改用其所在章节的名称。
- 描述:点出产品以及这些问题涵盖的关键主题领域。
复制此骨架并按你的主题进行改写:
---
title: FAQ
description: Answers to common questions about <product>, covering <the key topic areas>.
pcx_content_type: faq
sidebar:
order: 10
products:
- product-a
---
用一小段开篇,说明主题以及读者可以期待找到什么。
## <Question written in full from the reader's point of view>
先给出直接回答,再补充一两句上下文,并链接到完整解答该问题的如何操作、教程或词汇表。
## <Next question>
完整作答,并外链到事实来源。- 上下文用一小段开篇,说明主题以及读者可以期待找到什么。
- 当 FAQ 大到需要分组时,导航列出各章节,方便读者跳到正确分组。
- 链接把读者从点出的问题带到完整解答它的如何操作、教程或词汇表条目。
- 不适合放入的内容: 长程序或穷尽定义。把它们放在权威的如何操作、教程或词汇表中并给出链接。
pcx_content_type: faq
products:
- product-a
- product-b欲了解更多详情,请参考 pcx_content_type。
完整写出每个问题,并从读者的角度使用第一人称。优先使用 “Can I use wildcards when creating policies?”,而不是 “Can users use wildcards when creating policies?”。回答要完整;当问题以是/否提出时,先给出直接回应再补充上下文。优先使用 “Yes. Cloudflare Access supports several providers simultaneously.”,而不是省略开头 “Yes” 的回答。
大多数问题属于以下五类之一,每类都有自己的回答形态:
| 类型 | 问题形态 | 如何回答 |
|---|---|---|
| 是/否 | “Can I...”、“Does the product...” | 先回答 Yes 或 No,再补一两句上下文 |
| 程序型 | “How do I...”、“How does it work?” | 给出简明回答,然后链接到涵盖它的如何操作或教程 |
| 定义型 | “What is...?” | 给出简短、词典式定义,然后链接到词汇表 |
| 场景型 | “What if...?” | 第一句说明产品是否适用,再补充上下文并给出外链 |
| 故障排除 | “I see...”、“It does not work when...” | 先说明原因,再给出简短可操作步骤,然后链接到更深入文档 |
- 小型页面(大约不超过 10 个问题)不需要章节:一个标题、一段上下文,然后是问题和回答。
- 中型页面 增加章节标题,以及列出这些标题的导航菜单。
- 大型 FAQ(例如 Cloudflare One 这类产品套件)把每个章节拆到自己的子页面:主页面列出各章节、一行上下文以及指向每个子页面的按钮;每个子页面在返回落地页的面包屑导航下承载该章节的问题。
- 完整问题文本。 从读者角度写出每个问题的完整文本,因为智能体匹配的是整个问题,而不是截断的标题。
- 直接回答。 先给出直接回应;若问题是是/否型,先写 Yes 或 No,以便读者或智能体在第一句就得到事实。
- 链接到事实来源。 把每个程序型、定义型或场景型回答指向其权威的如何操作、教程或词汇表条目,因为 FAQ 是捷径,而不是权威来源。