사용자 가이드 & 튜토리얼
고객 지원 챗봇과 RAG가 정확히 매칭하도록 FAQ를 구조화된 Q&A로, 튜토리얼을 전제조건-단계-결과 확인 패턴으로 설계하고 이미지에 텍스트 대체를 병행하는 방법.
핵심 요약
- 사용자 가이드는 고객 지원 AI·도움말 챗봇·RAG 검색이 가져다 쓰는 소스라, 구조화 여부가 답변 정확도를 좌우합니다.
- 산문형 FAQ 대신 question/answer/tags/related를 갖춘 구조화된 Q&A 쌍으로 만듭니다.
- 튜토리얼은 전제조건 → 단계 → 결과 확인 패턴을 따라, AI가 중간 단계부터 안내하는 일을 막습니다.
- AI가 이미지 속 텍스트를 못 읽을 때가 있으니 모든 이미지에 텍스트 설명을 함께 답니다.
- 문제 해결은 증상→원인→해결 표로 정리하고 frontmatter에 category와 tags를 둡니다.
사용자 가이드는 AI 챗봇과 서포트 에이전트가 가장 많이 참조하는 문서입니다. 가이드가 구조화돼 있으면 AI는 정확한 답을 내놓고, 없으면 추측합니다.
왜 사용자 가이드가 AI 시대에 중요한가
고객 지원 AI, 제품 내 도움말 챗봇, RAG 기반 검색 시스템 모두 사용자 가이드를 소스로 씁니다. 문서가 잘 구조화돼 있으면 AI는 질문에 딱 맞는 답을 찾아냅니다.
AI-readable 사용자 가이드 원칙
1. FAQ → 구조화된 Q&A
기존 FAQ는 산문형이라 AI가 질문-답변 쌍을 정확히 매칭하기 어렵습니다.
Before:
## FAQ
비밀번호를 잊어버렸어요.
로그인 페이지에서 "비밀번호 찾기"를 클릭하면 이메일로 재설정 링크가 갑니다.After:
- question: 비밀번호를 잊어버렸을 때 어떻게 하나요?
answer: |
1. 로그인 페이지에서 "비밀번호 찾기" 클릭
2. 가입 시 사용한 이메일 입력
3. 이메일로 전송된 재설정 링크 클릭
4. 새 비밀번호 설정 (8자 이상, 특수문자 포함)
tags: [인증, 비밀번호, 로그인]
related: [이메일-변경, 계정-복구]2. 단계별 구조화
튜토리얼은 전제조건 → 단계 → 결과 확인 패턴을 따릅니다.
## [기능명] 설정 방법
### 전제조건
- [필요한 것 1]
- [필요한 것 2]
### 단계
1. **[행동]** — [설명]
2. **[행동]** — [설명]
3. **[행동]** — [설명]
### 결과 확인
- [예상 결과]
- [문제 발생 시 참조]: [링크]3. 이미지의 텍스트 대체
AI가 이미지 속 텍스트를 늘 읽어내지는 못합니다. 모든 이미지에 텍스트 설명을 함께 답니다.
**화면 설명**: 설정 > 보안 > 2단계 인증에서
"활성화" 버튼을 클릭합니다. 활성화 후 QR 코드가 표시됩니다.템플릿: 사용자 가이드 페이지
---
title: [기능명]
description: [한 줄 설명]
category: [카테고리]
tags: [태그1, 태그2]
difficulty: beginner | intermediate | advanced
---
## 개요
[이 기능이 무엇이고, 언제 사용하는지 2-3문장]
## 전제조건
- [필요한 것]
## 사용 방법
### 기본 사용
1. **[행동]** — [설명]
2. **[행동]** — [설명]
### 고급 옵션
- [옵션 1]: [설명]
- [옵션 2]: [설명]
## 자주 묻는 질문
**Q: [질문]**
A: [답변]
**Q: [질문]**
A: [답변]
## 문제 해결
| 증상 | 원인 | 해결 |
|---|---|---|
| [증상] | [원인] | [해결] |
## 관련 문서
- [관련 기능 1](링크)
- [관련 기능 2](링크)AI가 실패하는 패턴
| 실수 | AI가 실패하는 이유 | 수정 방법 |
|---|---|---|
| FAQ가 카테고리 없이 나열 | AI가 관련 답변을 못 찾음 | tags와 category로 분류 |
| "위 화면 참고"만 작성 | AI가 이미지 내 텍스트를 못 읽을 수 있음 | 텍스트 설명 병행 |
| 전제조건 생략 | AI가 중간 단계부터 안내 → 사용자 혼란 | 전제조건 섹션 필수 |
AI 프롬프트 예시
다음 기능에 대한 사용자 가이드를 작성해줘.
기능: [기능명]
대상: [초보자/중급/고급]
포함할 내용: 개요, 전제조건, 단계별 사용법, FAQ, 문제 해결
원칙:
- 단계별로 번호를 매겨 구조화
- 각 단계에 예상 결과를 포함
- FAQ는 질문-답변 쌍으로 명확하게
- 문제 해결은 증상→원인→해결 표로체크리스트
| 항목 | 확인 |
|---|---|
| 전제조건이 명시되어 있는가 | ☐ |
| 단계가 번호로 구조화되어 있는가 | ☐ |
| 각 단계에 예상 결과가 있는가 | ☐ |
| FAQ가 Q&A 쌍으로 구분되어 있는가 | ☐ |
| 이미지에 텍스트 설명이 병행되는가 | ☐ |
| 문제 해결이 표로 구조화되어 있는가 | ☐ |
| 관련 문서 링크가 포함되어 있는가 | ☐ |
| frontmatter에 category와 tags가 있는가 | ☐ |