스타일 가이드

로캘: en-US

사용 사례: SaaS B2B 제품 – 고객 센터 및 UI

# 스타일 가이드: EN-US – 고객 센터 기사

## 1. 목적 및 범위

이 스타일 가이드는 **영어(미국)**로 된 모든 **고객 센터 문서**의 작성 기준을 정의합니다.

적용 대상:

- 사용 방법 기사  
- 기능 설명  
- 문제 해결 가이드  
- FAQ 항목  

**대상:** 기술 및 비즈니스 역할의 전문 SaaS 사용자  
**목표:** 사용자가 신속하고 자신 있게 혼란 없이 작업을 완료하도록 돕는 것입니다.

---

## 2. 음성 및 톤

고객 센터 콘텐츠는 다음과 같이 들려야 합니다:

- **명확하고 전문적**
- **지원적이고 해결 중심**
- **자신감 있고 홍보적이지 않음**

우리는 사용자가 성공하도록 돕는 가이드로서 글을 씁니다 — 마케팅 카피가 아닙니다.

### 톤 원칙

| 해야 할 일 | 하지 말아야 할 일 |
|---|------|
| 차분하고 직접적이어야 함 | 지나치게 캐주얼하거나 수다스러워서는 안 됨 |
| 다음 단계에 집중해야 함 | 잘못된 점에만 집중해서는 안 됨 |
| 중립적인 언어 사용 | 풍자나 유머 사용 |

**예시**

- ✅ “연결이 실패하면, API 토큰을 확인하고 다시 시도하세요.”  
- ❌ “당신의 토큰이 잘못되었습니다.” 수정하세요.”

---

## 3. 문법 및 글쓰기 스타일

### 3.1 독자에게 직접 말하기

**당신**을 사용하여 지침을 명확하게 하세요.

- ✅ “관리자 페이지에서 사용자를 관리할 수 있습니다.”  
- ❌ “사용자는 관리자 페이지에서 관리될 수 있습니다.”

---

### 3.2 능동태 선호하기

능동태는 더 짧고 따라가기 쉽습니다.

- ✅ “**변경 사항 저장**을 선택하세요.”  
- ❌ “변경 사항 저장이 선택되어야 합니다.”

---

### 3.3 문장을 간결하게 유지하기

- **25단어 이하**를 목표로 하세요.
- 문장당 하나의 주요 아이디어
- 긴 설명은 단계나 글머리로 나누세요.

---

### 3.4 간단한 언어 사용하기

불필요한 복잡성을 피하세요.

- ✅ “새 프로젝트를 시작하세요.”  
- ❌ “새 프로젝트 생성 시작.”

---

## 4. 용어 및 일관성

### 4.1 승인된 용어 사용

정확히 정의된 제품 및 기능 이름을 사용하십시오.

- 대문자 사용을 일관되게 유지하십시오.  
- 주요 개념에 대한 동의어를 만들지 마십시오.  

**사례**

- ✅ “작업 공간”  
- ❌ “공간,” “프로젝트 영역,” “환경”

---

### 4.2 드문 약어 정의

일반 용어(API, URL)는 정의할 필요가 없습니다.  
내부 또는 드문 약어는 처음 사용할 때 설명해야 합니다.

- ✅ “싱글 사인온(SSO)”  
- ❌ “SSO” 맥락 없이

---

### 4.3 미국 영어 관습

항상 **en-US 철자법**을 사용하십시오.

- ✅ “사용자 정의,” “행동”  
- ❌ “사용자 정의,” “행동”

---

## 5. 형식 및 마크다운 표준

### 5.1 제목

명확하고 과업 기반의 제목을 사용하십시오.

- ✅ “비밀번호 재설정”  
- ❌ “비밀번호 재설정 프로세스 개요”

제목 계층 구조:

- `#` 문서 제목  
- `##` 주요 섹션  
- `###` 필요할 때만 하위 섹션  

---

### 5.2 목록

순서를 위해 번호 매기기 목록을 사용하십시오:

1. **설정** 열기  
2. **청구** 선택  
3. **요금제 변경** 선택  

옵션을 위해 글머리 기호를 사용하십시오:

- 관리자들은 사용자를 관리할 수 있습니다.  
- 편집자들은 콘텐츠를 업데이트할 수 있습니다.  

---

### 5.3 UI 요소

UI 레이블을 일관되게 형식화하십시오:

- 버튼: **굵게**
- 탐색 경로: 화살표 사용

예:

**설정 → 청구 → 요금제 변경**으로 이동하십시오.

---

### 5.4 링크

링크는 목적지를 설명해야 합니다.

- ✅ “청구 가이드를 참조하십시오”  
- ❌ “여기를 클릭하십시오”

---

## 6. 표준 기사 구조

모든 고객 센터 기사는 이 구조를 따라야 합니다:

### 1. 요약

결과를 설명하는 1-2 문장으로 시작하십시오.

> 이 기사는 구독 요금제를 변경하는 방법을 설명합니다.

---

### 2. 전제 조건 (선택 사항)

요구 사항을 미리 나열하십시오.

- 관리자 권한  
- 활성 구독  

---

### 3. 단계별 지침

단계는 다음과 같아야 합니다:

- 행동 지향적이어야 합니다.  
- 단계당 하나의 행동  
- 명령어로 작성되어야 합니다.  

예:

1. **설정**으로 이동하십시오.  
2. **청구**를 선택하십시오.  
3. **요금제 변경**을 선택하십시오.  

---

### 4. 예상 결과

사용자에게 어떤 일이 발생해야 하는지 알려주십시오.

> 귀하의 새로운 요금제가 확인 후 즉시 적용됩니다.

---

### 5. 다음 단계 (선택 사항)

관련 작업 또는 링크를 제공하십시오.

- 송장 관리  
- 결제 방법 업데이트  

---

## 7. 문제 해결 및 오류

### 7.1 안심시키기

- ✅ “연결할 수 없습니다. 다시 시도해 주십시오.”  
- ❌ “연결 실패. 치명적인 오류입니다.”

---

### 7.2 해결책에 집중하기

사용자가 다음에 해야 할 일을 항상 포함하십시오.

- 자격 증명 확인  
- 권한 확인  
- 필요시 지원에 문의하십시오.  

---

### 7.3 절대 사용자를 비난하지 마십시오

다음과 같은 언어를 피하십시오:

- “당신이 뭔가 잘못했습니다”  
- “유효하지 않은 입력” (설명 없이)

선호하는 표현:

> “토큰이 만료되었을 수 있습니다.” 새로운 토큰을 생성하고 다시 시도하십시오.”

---

## 8. 행동 요약

### 해야 할 일

- 과업 중심의 단계별 콘텐츠 작성  
- 일관된 용어 사용  
- 문장을 짧고 직접적으로 유지  
- 설명적인 제목과 링크 사용  
- 차분하고 지원적인 어조 유지  

### 하지 말아야 할 일

- 마케팅 언어 추가  
- 관용구나 속어 사용  
- 동일한 개념에 대해 용어 혼합  
- 문제 해결 시 사용자를 비난  
- 구조 없이 긴 단락 작성  

---

## 예시 (선호하는)

요금제를 변경하려면:

1. **설정 → 청구**로 이동하세요.  
2. **요금제 변경**을 선택하세요.  
3. 옵션을 선택하고 **확인**을 선택하세요.