187 lines
5.6 KiB
Markdown
187 lines
5.6 KiB
Markdown
## AI Writing Check
|
|
|
|
AI 가 생성한 문장의 기계적인 패턴을 검출하고, 더 자연스러운 한국어로의 개선 제안을 수행합니다.
|
|
|
|
### 사용법
|
|
|
|
```bash
|
|
/ai-writing-check [옵션]
|
|
```
|
|
|
|
### 옵션
|
|
|
|
- 없음 : 현재 파일 또는 선택한 텍스트를 분석
|
|
- `--file <path>` : 특정 파일을 분석
|
|
- `--dir <path>` : 디렉터리 내의 파일을 일괄 분석
|
|
- `--severity <level>` : 검출 레벨 (all/high/medium)
|
|
- `--fix` : 검출된 패턴을 자동 수정
|
|
|
|
### 기본 예제
|
|
|
|
```bash
|
|
# 파일의 AI 냄새를 체크
|
|
cat README.md
|
|
/ai-writing-check
|
|
「이 문서의 AI 냄새를 체크해서 개선안을 제시하세요」
|
|
|
|
# 특정 파일의 분석
|
|
/ai-writing-check --file docs/guide.md
|
|
「AI 같은 표현을 검출해서 자연스러운 표현으로 수정 제안하세요」
|
|
|
|
# 프로젝트 전체의 스캔
|
|
/ai-writing-check --dir . --severity high
|
|
「프로젝트 내의 중요한 AI 냄새 문제만 보고하세요」
|
|
```
|
|
|
|
### 검출 패턴
|
|
|
|
#### 1. 리스트 서식의 기계적 패턴
|
|
|
|
```markdown
|
|
검출되는 예:
|
|
|
|
- **중요**: 이는 중요한 항목입니다
|
|
- 완료된 항목 (체크마크 포함)
|
|
- 핫한 화제 (불꽃 이모지 포함)
|
|
- 시작 준비 완료 (로켓 이모지 포함)
|
|
|
|
개선 예:
|
|
|
|
- 중요한 항목: 이는 중요한 항목입니다
|
|
- 완료된 항목
|
|
- 주목받는 화제
|
|
- 시작 준비 완료
|
|
```
|
|
|
|
#### 2. 과장적·하이프 표현
|
|
|
|
```markdown
|
|
검출되는 예:
|
|
혁신적인 기술로 업계를 변화시킵니다.
|
|
이것은 완전히 문제를 해결합니다.
|
|
마법처럼 작동합니다.
|
|
|
|
개선 예:
|
|
효과적인 기술로 업계에 변화를 가져다줍니다.
|
|
많은 문제를 해결합니다.
|
|
부드럽게 작동합니다.
|
|
```
|
|
|
|
#### 3. 기계적인 강조 패턴
|
|
|
|
```markdown
|
|
검출되는 예:
|
|
**아이디어**: 새로운 제안이 있습니다 (전구 이모지 포함)
|
|
**주의**: 중요한 경고 사항 (경고 이모지 포함)
|
|
|
|
개선 예:
|
|
아이디어: 새로운 제안이 있습니다
|
|
주의사항: 중요한 경고 사항
|
|
```
|
|
|
|
#### 4. 장황한 테크니컬 라이팅
|
|
|
|
```markdown
|
|
검출되는 예:
|
|
먼저 처음에 설정을 수행합니다.
|
|
이 도구를 사용할 수 있습니다.
|
|
대폭 성능이 향상됩니다.
|
|
|
|
개선 예:
|
|
먼저 설정을 수행합니다.
|
|
이 도구를 사용 가능합니다.
|
|
성능이 30% 향상됩니다.
|
|
```
|
|
|
|
### Claude 와의 연계
|
|
|
|
```bash
|
|
# 문서 전체의 AI 냄새 분석
|
|
cat article.md
|
|
/ai-writing-check
|
|
「다음 관점으로 분석해서 개선안을 제시하세요:
|
|
1. 기계적인 표현의 검출
|
|
2. 자연스러운 한국어로의 수정 제안
|
|
3. 우선순위별 개선 리스트」
|
|
|
|
# 특정 패턴에 포커스
|
|
/ai-writing-check --file blog.md
|
|
「특히 과장 표현과 장황한 표현에 주목해서 개선 제안하세요」
|
|
|
|
# 복수 파일의 일괄 체크
|
|
find . -name "*.md" -type f
|
|
/ai-writing-check --dir docs/
|
|
「문서 전체의 AI 냄새를 분석해서 요약을 작성하세요」
|
|
```
|
|
|
|
### 상세 예제
|
|
|
|
```bash
|
|
# 개선 전후의 비교
|
|
/ai-writing-check --file draft.md
|
|
「AI 냄새 나는 표현을 검출해서 다음 형식으로 제시하세요:
|
|
- 문제 부분 (행번호 포함)
|
|
- 문제의 종류와 이유
|
|
- 구체적인 개선안
|
|
- 개선을 통한 효과」
|
|
|
|
# 자동 수정 모드
|
|
/ai-writing-check --file report.md --fix
|
|
「검출된 패턴을 자동 수정해서 결과를 보고하세요」
|
|
|
|
# 프로젝트의 AI 냄새 리포트
|
|
/ai-writing-check --dir . --severity all
|
|
「프로젝트 전체의 AI 냄새를 분석해서:
|
|
1. 통계 정보 (패턴별 검출 수)
|
|
2. 가장 문제가 있는 파일 TOP 5
|
|
3. 개선 우선순위 매트릭스
|
|
4. 단계적인 개선 계획」
|
|
```
|
|
|
|
### 고급 사용 예제
|
|
|
|
```bash
|
|
# 커스텀 룰의 적용
|
|
/ai-writing-check --file spec.md
|
|
「기술 사양서로서 다음 추가 기준으로 체크하세요:
|
|
- 애매한 표현 (적절한, 필요에 따라)
|
|
- 구체성의 결여 (고속인 → 구체적인 수치)
|
|
- 일관성 없는 용어 사용」
|
|
|
|
# CI/CD 통합용 체크
|
|
/ai-writing-check --dir docs/ --severity high
|
|
「GitHub Actions 에서 실행 가능한 형식으로 결과를 출력하세요:
|
|
- 에러 수와 파일명
|
|
- 수정이 필요한 행번호
|
|
- exit code 설정」
|
|
|
|
# 스타일 가이드 준수 체크
|
|
/ai-writing-check --file manual.md
|
|
「회사 스타일 가이드에 기반해서 추가 체크하세요:
|
|
- 존댓말 사용 (합니다·습니다체 통일)
|
|
- 전문용어의 적절한 사용
|
|
- 독자에 대한 배려」
|
|
```
|
|
|
|
### 주의사항
|
|
|
|
- AI 냄새의 판정은 문맥에 따라 다르므로, 제안은 참고로 취급하세요
|
|
- 기술 문서, 블로그, 매뉴얼 등 문서의 종류에 따라 기준을 조정합니다
|
|
- 모든 제안을 받아들일 필요는 없으며, 적절한 것을 선택하세요
|
|
- `--fix` 옵션은 검출된 패턴을 자동으로 수정합니다
|
|
|
|
### 명령 실행 시의 동작
|
|
|
|
`/ai-writing-check` 명령을 실행하면 Claude 는 다음 처리를 수행합니다:
|
|
|
|
1. **패턴 검출**: 지정된 파일이나 텍스트에서 AI 냄새 나는 패턴을 검출
|
|
2. **구체적인 수정 제안**: 각 문제에 대해 행번호와 함께 수정안을 제시
|
|
3. **--fix 모드**: 검출된 패턴을 자동 수정하고 결과를 요약 표시
|
|
4. **리포트 생성**: 검출 수, 개선 우선순위, 수정 전후 비교를 제공
|
|
|
|
Claude 는 실제 파일 내용을 읽어들여 textlint-rule-preset-ai-writing 의 규칙에 기반하여 분석을 실행합니다.
|
|
|
|
### 참고
|
|
|
|
이 명령어는 [textlint-rule-preset-ai-writing](https://github.com/textlint-ja/textlint-rule-preset-ai-writing)의 룰셋을 참고하여 작성되었습니다. AI 가 생성한 문장의 기계적인 패턴을 검출하고 더 자연스러운 표현을 촉진하기 위한 textlint 규칙 프리셋입니다.
|