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.