FAQ 작성 템플릿
FAQ = 문제 현상 + 가능한 원인 + 해결 방법
일반적으로 FAQ는 다음 두 가지 유형으로 나눕니다.
1. 문제 처리
문제 제목
필수입니다.
개발자가 검색할 때 사용할 키워드를 고려하여 문제 현상을 한 문장으로 설명합니다.
문제 현상
선택 사항입니다.
개발자가 마주할 수 있는 오류 메시지나 비정상 상황을 설명합니다.
가능한 원인
선택 사항입니다.
문제를 일으키는 가능한 원인을 명확히 설명합니다.
해결 방법
실행할 수 있도록 단계별로 작성합니다.
2. 문의
문의 제목
개발자의 질문 관점에서 주제를 작성하고 검색하기 쉽도록 관련 키워드를 포함합니다.
개발자가 더 깊이 이해할 수 있도록 가이드, API 레퍼런스 또는 기타 리소스 링크를 추가할 수 있습니다.