القائمة
문서 컨벤션 검토. docs/ 또는 reference/ 의 마크다운 문서가 작성 규칙을 따르는지 검증합니다. "문서 검토", "컨벤션 체크" 등의 요청에 사용합니다.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | doc-review |
| description | 문서 컨벤션 검토. docs/ 또는 reference/ 의 마크다운 문서가 작성 규칙을 따르는지 검증합니다. "문서 검토", "컨벤션 체크" 등의 요청에 사용합니다. |
| user-invocable | true |
대상 파일: $ARGUMENTS
아래 체크리스트를 기준으로 대상 파일을 검토하세요. 인수가 없으면 git diff --name-only로 변경된 .md 파일을 대상으로 합니다.
각 항목을 검사하고 결과를 테이블로 보고하세요.
| # | 규칙 | 검사 방법 |
|---|---|---|
| 1 | 한국어 작성 | 본문이 한국어인지 확인. 코드/명령어/기술 용어 원문은 영어 허용 |
| 2 | 코드블록 언어 태그 | 모든 ``` 코드블록에 언어 태그(bash, json, yaml, markdown 등)가 있는지 확인 |
| 3 | 업데이트 날짜 | 문서 마지막 부분에 **마지막 업데이트**: YYYY-MM-DD 형식이 있는지 확인 |
| 4 | 문서 시작 구조 | # 제목 → > 한 줄 요약 → --- 순서인지 확인 |
| 5 | 비엔지니어 친화 | 기술 용어 첫 등장 시 간단한 설명이 있는지 확인 |
| 6 | 섹션 구분선 | 주요 섹션 사이에 --- 구분선이 있는지 확인 |
## 검토 결과: {파일명}
| # | 규칙 | 결과 | 비고 |
|---|------|------|------|
| 1 | 한국어 작성 | Pass/Fail | (위반 사항) |
| ... | ... | ... | ... |
### 수정 필요 사항
- (구체적인 수정 내용)
위반 사항이 없으면 "모든 컨벤션을 준수합니다"로 마무리하세요.