From 686834829700e27a63a53de463c1e5bc21ac4f07 Mon Sep 17 00:00:00 2001 From: JK Date: Thu, 15 Jan 2026 14:46:25 +0900 Subject: [PATCH 1/2] =?UTF-8?q?chore:=20Claude=20Code=20/proofread=20?= =?UTF-8?q?=EC=8A=A4=ED=82=AC=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Description - Claude Code에서 사용할 `/proofread` 스킬을 추가합니다. - MDX 문서의 교정/교열을 수행하기 위한 가이드를 제공합니다. ### 스킬 주요 기능 - 한국어/영어/일본어 문서 교정/교열 지원 - 결과 보고서 저장 위치 및 형식 정의 - 맞춤법, 문법, 표현, 용어 통일 검토 기준 - Markdown 형식 유지 규칙 - 피해야 할 표현 목록 ## Changes - `.claude/commands/proofread.md`: /proofread 스킬 정의 파일 추가 Co-Authored-By: Claude Opus 4.5 --- .claude/commands/proofread.md | 126 ++++++++++++++++++++++++++++++++++ 1 file changed, 126 insertions(+) create mode 100644 .claude/commands/proofread.md diff --git a/.claude/commands/proofread.md b/.claude/commands/proofread.md new file mode 100644 index 00000000..30d84589 --- /dev/null +++ b/.claude/commands/proofread.md @@ -0,0 +1,126 @@ +# 한국어 문서 교정/교열 Skill + +MDX 문서의 맞춤법, 문법, 표현, 용어 통일을 검토하고 개선합니다. + +## 문서 위치 + +- **원문 (한국어)**: `src/content/ko/**/*.mdx` +- **영어 번역**: `src/content/en/**/*.mdx` +- **일본어 번역**: `src/content/ja/**/*.mdx` +- **이미지**: `public/` 디렉토리 (언어 공통) + +## 교정/교열 결과 저장 위치 + +결과는 원문과 동일한 경로/파일명으로 저장합니다: + +- **한국어**: `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` + +## 작업 순서 + +1. `date` 명령으로 오늘 날짜 확인 +2. 대상 파일 확인 (사용자 지정 또는 현재 열린 파일) +3. 기존 검토 결과 확인 (`docs/proofreading/` 아래 파일 존재 여부) +4. 문서 내용 읽기 및 교정/교열 수행 +5. 결과 보고서를 `.md` 파일로 저장 +6. 명시적 지시가 있을 때만 원문 직접 수정 + +## 검토 대상 언어별 기준 + +### 한국어 (원문) +- 맞춤법, 문법, 띄어쓰기 검토 +- 표현/문체 개선 +- 용어 통일 + +### 영어/일본어 (번역문) +- 한국어 원문 기준 번역 정확성 검증 +- 표준 영어/일본어 표현 확인 +- Markdown 구조가 원문과 동일한지 확인 + +## 검토 항목 + +### 1. 맞춤법/문법 검토 +- 띄어쓰기 오류 +- 맞춤법 오류 +- 조사 사용 오류 +- 문장 부호 오류 + +### 2. 표현/문체 개선 +- 어색한 표현을 자연스럽게 수정 +- 장황한 문장을 간결하게 정리 +- 경어체 일관성 유지 (~합니다, ~입니다) +- 번역투 표현 개선 +- 격식을 갖추되 친화적인 대화체 사용 + +### 3. 용어 통일 +- 브랜드명 표기 통일 (QueryPie) +- 기술 용어 일관성 +- UI 요소명 통일 + +## 결과 보고서 형식 + +```markdown +# 교정/교열 결과: {파일명} + +**검토일시**: YYYY-MM-DD +**검토 수행 AI Agent**: Claude Opus 4.5 + +## 요약 +- 발견된 문제: N건 +- 수정 권장: N건 + +## 검토 결과 + +### 1. [문제 유형] (라인 N) +- **현재**: "현재 텍스트 전체 인용" +- **개선 제안**: "수정된 텍스트" +- **사유**: 수정 이유 + +### 2. [문제 유형] (라인 N) +... + +## 기타 의견 +- 전체적인 평가 +- 추가 권장 사항 +``` + +## 유의사항 + +### 반드시 유지할 것 +- Markdown 표현 형식 (표, 목록, 강조 등) +- 줄바꿈 형식 +- `**text**` 강조 표시 (`` 대체 금지) +- HTML Encode 문자열 (`<`, `>` 등) +- 중괄호로 감싸인 문자열의 backquote +- 문서 간 상대 경로 링크 +- 코드 블록 내용 +- 이미지 경로 + +### 피해야 할 표현 + +| 피해야 할 표현 | 권장 표현 | +|--------------|----------| +| ~를 통하여 | ~를 통해 | +| ~를 진행합니다 | ~합니다 | +| ~에 대해서 | ~에 대해 | +| ~하실 수 있습니다 | ~할 수 있습니다 | +| ~되어집니다 | ~됩니다 | + +### 문체 기준 +- 격식을 갖춘 표현 사용 +- 친화적인 대화체 선호 (딱딱하고 건조한 문체 지양) +- 일상적 구어체, 가벼운 문체 금지 + +## 작업 규칙 + +- 기존 검토 결과가 있는 문서는 재검토하지 않음 (별도 지시 없으면) +- 한 번에 최대 50개 문서 검토 후 리뷰 요청 +- 원문 직접 수정은 명시적 지시가 있을 때만 수행 +- 수정 적용 후 `npm run build`로 빌드 확인 + +## Feedback + +검토 과정에서 발견한 어려움이나 의견은 `docs/proofreading.md`의 "AI Agent 로부터의 Feedback" 섹션에 기록합니다. \ No newline at end of file From 0c59bc9cc148c6c36262b153a3a3db835bed899f Mon Sep 17 00:00:00 2001 From: JK Date: Thu, 15 Jan 2026 15:01:04 +0900 Subject: [PATCH 2/2] =?UTF-8?q?chore:=20/proofread=20=EC=8A=A4=ED=82=AC?= =?UTF-8?q?=EC=97=90=20docs/proofreading.md=20=ED=86=B5=ED=95=A9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Description - docs/proofreading.md의 내용을 .claude/commands/proofread.md로 통합합니다. - 중복 문서 제거를 위해 docs/proofreading.md를 삭제합니다. ### 통합된 내용 - 문서 목적 및 대상 독자 설명 - MDX 형식 및 이미지 Caption 번역 지침 - 검토 결과 1:1 대응 규칙 - 번역 관련 지침 ### 변경된 내용 - 빌드 검증을 CI Pipeline 의존 방식으로 변경 - AI Agent Feedback 섹션 제거 ## Changes - `.claude/commands/proofread.md`: docs/proofreading.md 내용 통합 - `docs/proofreading.md`: 삭제 Co-Authored-By: Claude Opus 4.5 --- .claude/commands/proofread.md | 63 +++++++++++++++++++-------- docs/proofreading.md | 81 ----------------------------------- 2 files changed, 44 insertions(+), 100 deletions(-) delete mode 100644 docs/proofreading.md diff --git a/.claude/commands/proofread.md b/.claude/commands/proofread.md index 30d84589..2f3e0864 100644 --- a/.claude/commands/proofread.md +++ b/.claude/commands/proofread.md @@ -1,17 +1,37 @@ -# 한국어 문서 교정/교열 Skill +# 문서 교정/교열 Skill -MDX 문서의 맞춤법, 문법, 표현, 용어 통일을 검토하고 개선합니다. +Markdown으로 작성된 컨텐츠 문서를 교정, 교열합니다. -## 문서 위치 +- 이 문서는 Claude, JetBrains Junie, ChatGPT 등 LLM 모델 기반의 AI Agent가 참조하기 위한 목적으로 작성되었습니다. +- 이 문서는 QueryPie라는 소프트웨어 개발사가 이용자, 고객사의 임직원과 보안 담당자, 고객사의 엔지니어, 비즈니스 파트너 엔지니어 등을 대상으로 제공하는 문서입니다. -- **원문 (한국어)**: `src/content/ko/**/*.mdx` -- **영어 번역**: `src/content/en/**/*.mdx` -- **일본어 번역**: `src/content/ja/**/*.mdx` -- **이미지**: `public/` 디렉토리 (언어 공통) +## 컨텐츠 문서 위치 + +### 원문 (한국어) +- `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` @@ -19,13 +39,15 @@ MDX 문서의 맞춤법, 문법, 표현, 용어 통일을 검토하고 개선합 예시: `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` 파일로 저장 +5. 결과 보고서를 `.md` 파일로 저장 (한국어로 작성) 6. 명시적 지시가 있을 때만 원문 직접 수정 ## 검토 대상 언어별 기준 @@ -39,6 +61,7 @@ MDX 문서의 맞춤법, 문법, 표현, 용어 통일을 검토하고 개선합 - 한국어 원문 기준 번역 정확성 검증 - 표준 영어/일본어 표현 확인 - Markdown 구조가 원문과 동일한지 확인 +- Markdown 표현 형식이 원문과 다르면 원문과 동일하게 수정 ## 검토 항목 @@ -54,6 +77,8 @@ MDX 문서의 맞춤법, 문법, 표현, 용어 통일을 검토하고 개선합 - 경어체 일관성 유지 (~합니다, ~입니다) - 번역투 표현 개선 - 격식을 갖추되 친화적인 대화체 사용 + - 딱딱하고 건조한 문체보다 이용자에게 친화적인 대화체 선호 + - 일상적인 구어체, 친구들 사이에 사용하는 가벼운 문체는 사용하지 않음 ### 3. 용어 통일 - 브랜드명 표기 통일 (QueryPie) @@ -93,8 +118,11 @@ MDX 문서의 맞춤법, 문법, 표현, 용어 통일을 검토하고 개선합 - Markdown 표현 형식 (표, 목록, 강조 등) - 줄바꿈 형식 - `**text**` 강조 표시 (`` 대체 금지) -- HTML Encode 문자열 (`<`, `>` 등) -- 중괄호로 감싸인 문자열의 backquote +- HTML Encode 문자열 유지 (임의로 Decode 금지) + - `<`, `>`로 HTML Encode된 문자열 그대로 유지 + - 예: 원문의 `<token>`을 ``으로 변경 금지 +- 중괄호로 감싸인 문자열의 backquote 유지 + - 예: `{querypie url}` 그대로 유지 - 문서 간 상대 경로 링크 - 코드 블록 내용 - 이미지 경로 @@ -109,18 +137,15 @@ MDX 문서의 맞춤법, 문법, 표현, 용어 통일을 검토하고 개선합 | ~하실 수 있습니다 | ~할 수 있습니다 | | ~되어집니다 | ~됩니다 | -### 문체 기준 -- 격식을 갖춘 표현 사용 -- 친화적인 대화체 선호 (딱딱하고 건조한 문체 지양) -- 일상적 구어체, 가벼운 문체 금지 - ## 작업 규칙 - 기존 검토 결과가 있는 문서는 재검토하지 않음 (별도 지시 없으면) +- 이미 번역된 문서는 다시 번역하지 않음 (별도 지시 없으면) - 한 번에 최대 50개 문서 검토 후 리뷰 요청 - 원문 직접 수정은 명시적 지시가 있을 때만 수행 -- 수정 적용 후 `npm run build`로 빌드 확인 -## Feedback +## 빌드 검증 -검토 과정에서 발견한 어려움이나 의견은 `docs/proofreading.md`의 "AI Agent 로부터의 Feedback" 섹션에 기록합니다. \ No newline at end of file +- PR 생성 시 CI Pipeline에서 자동으로 빌드를 검증합니다. +- 로컬에서 `npm run build`를 실행하는 것은 선택사항입니다. +- CI Pipeline에서 빌드 오류 발생 시 에러 메시지를 확인하고 수정합니다. diff --git a/docs/proofreading.md b/docs/proofreading.md deleted file mode 100644 index c32c16b0..00000000 --- a/docs/proofreading.md +++ /dev/null @@ -1,81 +0,0 @@ -# Markdown 으로 작성된 컨텐츠 문서를 교정, 교열합니다. - -- 이 문서는 Claude, JetBrains Junie, ChatGPT 등 LLM 모델 기반의 AI Agent 가 참조하기 위한 목적으로 작성되었습니다. - -## 컨텐츠의 원문 - -- [src/content/ko](../src/content/ko) 아래의 .mdx 확장자를 가진 MDX 문서가 원문입니다. -- 원문은 한국어로 작성되어 있습니다. -- MDX 문서는 Markdown 에 JSX 기능을 확장한 문서양식입니다. MDX 문서는 서로 참조하는 링크를 갖고 있습니다. -- 컨텐츠 원문은 스크린샷과 같은 이미지 파일을 본문에 포함하고 있습니다. 이미지 파일은 [public/](../public) 디렉토리에 놓여 있습니다. -- 이미지 파일은 언어에 무관하게 공통적으로 사용할 수 있습니다. 따라서, 원문을 번역하더라도, 이미지 파일을 교체하지 않고, 그대로 사용할 수 있습니다. - -## 영어로 번역된 컨텐츠 - -- [src/content/en](../src/content/en) 아래의 .mdx 확장자를 가진 MDX 문서가 영어로 번역된 문서입니다. -- 이 문서는 표준 영어로 작성되어야 합니다. -- 문서의 경로, 파일이름은 컨텐츠의 원문과 동일한 경로, 파일이름을 사용하여야 합니다. - - `src/content/ko/path/filename.mdx`라는 원문의 경우, `src/content/en/path/filename/.mdx`라는 영어 문서가 대응합니다. - - 다시 말해, `src/content/ko/`, `src/content/en/` 의 경로는 언어에 따라 다르지만, 그 이후 경로와 파일이름은 동일하여야 합니다. -- 번역된 문서는 스크린샷과 같은 이미지 파일을 본문에 포함할 수 있습니다. 이때, 한국어 원문에 사용된 이미지 파일을 동일하게 사용합니다. - - 이미지 파일의 Caption 등 설명 문구는 한국어 원문을 영어로 번역하는 대상이 됩니다. - -## 일본어로 번역된 컨텐츠 - -- [src/content/ja](../src/content/ja) 아래의 .mdx 확장자를 가진 MDX 문서가 일본어로 번역된 문서입니다. -- 이 문서는 표준 일본어로 작성되어야 합니다. -- 문서의 경로, 파일이름은 컨텐츠의 원문과 동일한 경로, 파일이름을 사용하여야 합니다. - - `src/content/ko/path/filename.mdx`라는 원문의 경우, `src/content/ja/path/filename/.mdx`라는 일본어 문서가 대응합니다. - - 다시 말해, `src/content/ko/`, `src/content/ja/` 의 경로는 언어에 따라 다르지만, 그 이후 경로와 파일이름은 동일하여야 합니다. -- 번역된 문서는 스크린샷과 같은 이미지 파일을 본문에 포함할 수 있습니다. 이때, 한국어 원문에 사용된 이미지 파일을 동일하게 사용합니다. - - 이미지 파일의 Caption 등 설명 문구는 한국어 원문을 일본어로 번역하는 대상이 됩니다. - -## 교정, 교열을 수행하는 방법 -- 교정, 교열은 MDX 문서 단위로 수행합니다. -- 한국어, 영어, 일본어, 3개 언어의 문서를 모두 대상으로 합니다. 영어, 일본어 문서의 경우, 한국어 원문을 기준으로, 충실하고 올바르게 번역되었는지, 검증합니다. -- 교정, 교열의 결과를 .md 확장자를 가진 Markdown 문서로 기록합니다. - - 한국어 문서에 대한 교정, 교열의 결과를 [docs/proofreading/ko/](proofreading/ko/) 아래에 원문의 경로, 파일이름과 동일하게 저장합니다. - - 영어 문서에 대한 교정, 교열의 결과를 [docs/proofreading/ko/](proofreading/en/) 아래에 원문의 경로, 파일이름과 동일하게 저장합니다. - - 일본어 문서에 대한 교정, 교열의 결과를 [docs/proofreading/ko/](proofreading/ja/) 아래에 원문의 경로, 파일이름과 동일하게 저장합니다. - - 예시) `src/content/ko/path/filename.mdx`에 대한 교정, 교열의 결과를 `docs/proofreading/ko/path/filename.md`에 저장합니다. -- 명시적으로 지시받지 않으면, 교정, 교열의 과정은 원문을 곧바로 수정하지 않고, 검토 결과를 .md 확장자를 가진 Markdown 문서로 기록합니다. - - 검토 결과는 한국어로 작성합니다. - - 검토일시, 검토를 수행한 AI Agent 의 이름을 명시합니다. - - 하나의 .mdx 파일에 대한 검토는 하나의 .md 파일에 결과를 기록합니다. 1:1 대응이 되도록 검토 결과를 작성하여 주세요. - - 다시 말해, `docs/proofreading/` 아래에 .md 파일이 존재하는 경우, 해당 문서는 검토가 완료된 것을 의미합니다. - - 검토 대상의 예시 문장을 완전하게 인용하고, 개선할 문장이나 표현을 제시합니다. -- 검토일시는 터미널에서 `date`명령을 수행하여, 오늘의 날짜를 알아냅니다. - -## 교정, 교열시 유의할 사항 - -- 이 문서는 QueryPie 라는 소프트웨어 개발사가 이용자, 고객사의 임직원과 보안 담당자, 고객사의 엔지니어, 비즈니스 파트너 엔지니어 등을 대상으로 제공하는 문서입니다. -- 높은 수준의 품질과 기술지원을 제공하는 소프트웨어 제조사의 입장에서, 격식을 갖춘 표현을 사용하여 주세요. - - 딱딱하고 건조한 문체보다, 이용자에게 친화적인 대화체를 사용하는 것을 선호합니다. - - 그러나, 일상적인 구어체, 친구들 사이에 사용하는 가벼운 문체를 사용하지 않아야 합니다. -- 원문의 MDX 파일에 사용된 markdown 표현 형식, 줄바꿈 등 형식을 번역, 수정한 문서에 그대로 유지하여 주세요. - - 표, 목록, 강조(예: **text**) 등 마크다운 구조는 한국어 원문과 동일하게 유지한다. - - `**Example Phrase**`와 같이 `**`를 이용해 강조표시된 Markdown 구문을 그대로 유지합니다. ``으로 대체하지 않습니다. - - Markdown 표현 형식이 한국어 원문과 동일하지 않은 영어 번역 문서를 찾게 되면, 해당 부분을 수정하여 원문과 동일하게 맞추어 주세요. -- 원문의 MDX 파일에서 적절히 Escape 된 문자열을 임의로 Decode 하지 않습니다. - - `<` `>`로 HTML Encode 된 문자열을 그대로 유지합니다. - - 예시) 원문에서 `<token>` 인 문자열을 ``으로 옮기면 안 됩니다. 원문의 문자열, `<token>`을 유지하여야 합니다. - - 예시) 중괄호 Embrace 로 감싸인 문자열에 덧붙은 backquote 를 없애면 안 됩니다. 원문의 문자열, `{querypie url}`을 유지하여야 합니다. -- 문서 사이의 링크는 상대 경로를 유지합니다. - -## 번역, 수정 과정에 대한 지침 - -- 번역, 수정 과정이 1차 완료된 이후, `npm run build`를 수행하여, 번역, 수정된 MDX 파일이 올바르게 빌드되는지 확인합니다. - - 빌드 오류가 발생하는 경우, 에러 메시지에서 그 원인을 확인하고, 잘못된 부분을 고칩니다. - - `rpm run build`가 성공할 때까지, 위 과정을 반복합니다. - - `rpn run build`를 실행하기 위해, 명령 지시자에게 확인받지 않습니다. 직접 곧바로 명령을 수행합니다. -- 별도의 지시가 없으면, 이미 번역된 문서를 대상으로, 다시 번역하지 않습니다. - - 별도의 지시가 없으면, 이미 검토 결과가 작성된 문서에 대해, 교정, 교열을 수행하지 않습니다. -- 별도의 지시가 없으면, 한번에 50개의 문서를 번역하거나 검토한 이후, 작업을 완료하고, 명령 지시자에게 리뷰를 요청하세요. -- 원문 한국어에서 오타, 문법 오류, 어법에 맞지 않는 표현이 발견된 경우, 이에 대한 것을 Feedback 으로 남겨 주세요. -- 그 외 번역 과정에서 어려운 점이 발견된 경우, Feedback 으로 남겨 주세요. -- Feedback 남기는 방법 - - 이 문서의 마지막에 놓인 "# AI Agent 로부터의 Feedback" 섹션에 의견, 번역, 수정 과정의 어려움을 알려주세요. - -# AI Agent 로부터의 Feedback - -- to-be-added