Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 151 additions & 0 deletions .claude/commands/proofread.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
# 문서 교정/교열 Skill

Markdown으로 작성된 컨텐츠 문서를 교정, 교열합니다.

- 이 문서는 Claude, JetBrains Junie, ChatGPT 등 LLM 모델 기반의 AI Agent가 참조하기 위한 목적으로 작성되었습니다.
- 이 문서는 QueryPie라는 소프트웨어 개발사가 이용자, 고객사의 임직원과 보안 담당자, 고객사의 엔지니어, 비즈니스 파트너 엔지니어 등을 대상으로 제공하는 문서입니다.

## 컨텐츠 문서 위치

### 원문 (한국어)
- `src/content/ko/**/*.mdx`
- 원문은 한국어로 작성되어 있습니다.
- MDX 문서는 Markdown에 JSX 기능을 확장한 문서양식입니다. MDX 문서는 서로 참조하는 링크를 갖고 있습니다.

### 영어 번역
- `src/content/en/**/*.mdx`
- 표준 영어로 작성되어야 합니다.
- 문서의 경로, 파일이름은 원문과 동일해야 합니다.
- 예: `src/content/ko/path/filename.mdx` → `src/content/en/path/filename.mdx`

### 일본어 번역
- `src/content/ja/**/*.mdx`
- 표준 일본어로 작성되어야 합니다.
- 문서의 경로, 파일이름은 원문과 동일해야 합니다.
- 예: `src/content/ko/path/filename.mdx` → `src/content/ja/path/filename.mdx`

### 이미지
- `public/` 디렉토리에 위치
- 이미지 파일은 언어에 무관하게 공통으로 사용합니다. 번역 시 이미지 파일을 교체하지 않습니다.
- 이미지 파일의 Caption 등 설명 문구는 번역 대상입니다.

## 교정/교열 결과 저장 위치

결과는 원문과 동일한 경로/파일명의 `.md` 파일로 저장합니다:

- **한국어**: `docs/proofreading/ko/{path}/{filename}.md`
- **영어**: `docs/proofreading/en/{path}/{filename}.md`
- **일본어**: `docs/proofreading/ja/{path}/{filename}.md`

예시: `src/content/ko/administrator-manual.mdx` → `docs/proofreading/ko/administrator-manual.md`

**중요**: 하나의 `.mdx` 파일에 대한 검토는 하나의 `.md` 파일에 1:1 대응으로 기록합니다. `docs/proofreading/` 아래에 `.md` 파일이 존재하면 해당 문서는 검토 완료된 것입니다.

## 작업 순서

1. `date` 명령으로 오늘 날짜 확인
2. 대상 파일 확인 (사용자 지정 또는 현재 열린 파일)
3. 기존 검토 결과 확인 (`docs/proofreading/` 아래 파일 존재 여부)
4. 문서 내용 읽기 및 교정/교열 수행
5. 결과 보고서를 `.md` 파일로 저장 (한국어로 작성)
6. 명시적 지시가 있을 때만 원문 직접 수정

## 검토 대상 언어별 기준

### 한국어 (원문)
- 맞춤법, 문법, 띄어쓰기 검토
- 표현/문체 개선
- 용어 통일

### 영어/일본어 (번역문)
- 한국어 원문 기준 번역 정확성 검증
- 표준 영어/일본어 표현 확인
- Markdown 구조가 원문과 동일한지 확인
- Markdown 표현 형식이 원문과 다르면 원문과 동일하게 수정

## 검토 항목

### 1. 맞춤법/문법 검토
- 띄어쓰기 오류
- 맞춤법 오류
- 조사 사용 오류
- 문장 부호 오류

### 2. 표현/문체 개선
- 어색한 표현을 자연스럽게 수정
- 장황한 문장을 간결하게 정리
- 경어체 일관성 유지 (~합니다, ~입니다)
- 번역투 표현 개선
- 격식을 갖추되 친화적인 대화체 사용
- 딱딱하고 건조한 문체보다 이용자에게 친화적인 대화체 선호
- 일상적인 구어체, 친구들 사이에 사용하는 가벼운 문체는 사용하지 않음

### 3. 용어 통일
- 브랜드명 표기 통일 (QueryPie)
- 기술 용어 일관성
- UI 요소명 통일

## 결과 보고서 형식

```markdown
# 교정/교열 결과: {파일명}

**검토일시**: YYYY-MM-DD
**검토 수행 AI Agent**: Claude Opus 4.5

## 요약
- 발견된 문제: N건
- 수정 권장: N건

## 검토 결과

### 1. [문제 유형] (라인 N)
- **현재**: "현재 텍스트 전체 인용"
- **개선 제안**: "수정된 텍스트"
- **사유**: 수정 이유

### 2. [문제 유형] (라인 N)
...

## 기타 의견
- 전체적인 평가
- 추가 권장 사항
```

## 유의사항

### 반드시 유지할 것
- Markdown 표현 형식 (표, 목록, 강조 등)
- 줄바꿈 형식
- `**text**` 강조 표시 (`<strong>` 대체 금지)
- HTML Encode 문자열 유지 (임의로 Decode 금지)
- `&lt;`, `&gt;`로 HTML Encode된 문자열 그대로 유지
- 예: 원문의 `&lt;token&gt;`을 `<token>`으로 변경 금지
- 중괄호로 감싸인 문자열의 backquote 유지
- 예: `{querypie url}` 그대로 유지
- 문서 간 상대 경로 링크
- 코드 블록 내용
- 이미지 경로

### 피해야 할 표현

| 피해야 할 표현 | 권장 표현 |
|--------------|----------|
| ~를 통하여 | ~를 통해 |
| ~를 진행합니다 | ~합니다 |
| ~에 대해서 | ~에 대해 |
| ~하실 수 있습니다 | ~할 수 있습니다 |
| ~되어집니다 | ~됩니다 |

## 작업 규칙

- 기존 검토 결과가 있는 문서는 재검토하지 않음 (별도 지시 없으면)
- 이미 번역된 문서는 다시 번역하지 않음 (별도 지시 없으면)
- 한 번에 최대 50개 문서 검토 후 리뷰 요청
- 원문 직접 수정은 명시적 지시가 있을 때만 수행

## 빌드 검증

- PR 생성 시 CI Pipeline에서 자동으로 빌드를 검증합니다.
- 로컬에서 `npm run build`를 실행하는 것은 선택사항입니다.
- CI Pipeline에서 빌드 오류 발생 시 에러 메시지를 확인하고 수정합니다.
81 changes: 0 additions & 81 deletions docs/proofreading.md

This file was deleted.