# FAQ写作模板

常见问题（FAQ）倾向于通过简短的回答，回复一些常见的问题，包括但不限于产品/服务的基础概念、功能介绍、特性使用等常见问题。

从用户的高频提问中来，整合到开发者文档中去。将单个用户的疑问，深挖出实际的阻塞点，服务于用户的真实使用场景，在文档中帮助更多的用户。

## FAQ的标准

* FAQ属于参考性资料，是在用户遇到问题无法解决的时候，去查找或搜索的。
* 衡量FAQ好坏的标准主要有两点：
  - 第一点：用户能不能快速找到所需的FAQ。     →  **标题、问题现象**：相当于路标/地图，对于问题定位至关重要。
  - 第二点：FAQ能不能指导用户有效解决问题。  →  **可能原因、处理措施**。

所以，一般一个FAQ由这三部分组成：

**FAQ = 问题现象 + 可能原因 + 处理措施**

问题分为复杂问题和简单问题，部分简单问题中，标题已经说清楚了“问题现象”和“可能原因”，就可以省略重复部分。

| 用户场景                                                                | 写作实现的目的               | 对应的资料模块 | 对资料要求 |
| ----------------------------------------------------------------------- | ---------------------------- | -------------- | ---------- |
| 1、查找：根据遇到的问题现象、按图索骥，找到所匹配的FAQ。                | 易查找、易匹配               | 问题现象       | 具体化     |
| 2、分析：可选。对照可能原因，分析是否存在类似问题，获取解决问题的思路。 | 讲清原因，为解决问题做好铺垫 | 可能原因       | 逻辑性     |
| 3、处理：按照提供的处理措施来操作，无助求助、自助解决问题。             | 指导用户自助解决问题         | 处理措施       | 可执行     |

一般FAQ分为以下两类：

* [故障处理类](#故障处理类)
* [咨询类（含特性原理/规格/概念咨询、功能使用咨询）](#咨询类)


## 故障处理类

**标题：一句话简要描述问题的最终现象**

**问题现象**

从用户角度出发，描述用户可感知的报错。包括：问题出现的场景、现象、条件等。

（复杂问题可选）如有问题复现的完整操作流程，也在这个小标题下呈现。

**可能原因（可选）**

明确问题的根因。如果不同的原因对应不同的解决措施，需明确分点列举。

**解决措施**

- Step-by-step方式写作，保证可执行性。
- 以“动宾句式”的操作步骤为主，有时候还需要说明“操作目的”与当前步骤的“操作现象”。
- 理清逻辑关系（合理分层），并列关系采用无序列表，顺序关系（前后有依赖关系）采用有序列表。

**代码示例**

展示核心代码，提供可运行的代码片段。
如果是步骤执行代码，可与解决措施中的步骤合并。

**参考链接**

附指南/API参考/Sample等赋能套件的资料链接，方便开发者拓展阅读。

## 咨询类

**标题：以用户的疑问点切入，需要含有具体的特性关键词**

无需分隔子标题，直接答复实现方案、对应的规格约束等。如果有代码示例辅助解释，可以直接在解决方案后提供简单的示例代码片段。

**参考链接**

附指南/API参考/Sample等赋能套件的资料链接，方便开发者拓展阅读。