跳到主要内容

FAQ写作模板

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

一般 FAQ 分为以下两类：

一 问题处理​

问题标题​

必选。

一句话描述问题的现象，需要考虑到开发者使用哪些关键字进行搜索。

问题现象​

可选。

描述开发者可能遇到的报错，例如问题出现的场景现象等。

可能原因​

可选。

明确问题产生的原因。

解决措施​

step by step 方式写作，保证可执行性。

二 咨询​

咨询标题​

以开发者的疑问点切入，注意包含关键词以方便搜索。

可提供指南/API参考等资料链接，方便开发者深入理解。