FAQ Writing Template
FAQ = Issue Phenomenon + Possible Causes + Solutions
In general, FAQs are divided into the following two categories:
1. Issue Handlingโ
Issue Titleโ
Required.
Provide a one-sentence description of the issue phenomenon, considering the keywords developers may use when searching.
Issue Phenomenonโ
Optional.
Describe the error messages or abnormal scenarios developers may encounter.
Possible Causesโ
Optional.
Clearly explain the possible reasons that cause the issue.
Solutionsโ
Write in a step-by-step manner to ensure executability.
2. Consultationโ
Consultation Titleโ
Approach the topic from the developer's question point of view, and make sure to include relevant keywords for easier searching.
Optionally provide links to guides, API references, or other resources to help developers gain a deeper understanding.