By name: doc-checker description: ドキュメントの品質チェックを行う。マークダウン文書、README、技術文書を作成・編集する時に使用。 allowed-tools: Read, Write, Edit, Bash
ドキュメントチェッカー
概要
AIが文書を作成した後、スクリプトで品質チェックを行います。
AI + スクリプトの協調
- AIが得意なこと（判断・文章生成）→ AIに任せる
- スクリプトが得意なこと（機械的処理）→ スクリプトに任せる
ワークフロー
- AIの役割: 文書の本文を執筆・修正
- スクリプトの役割: 用語統一・必須項目チェック
チェックスクリプトの実行
文書作成・編集後、以下のコマンドでチェックを実行:
python .claude/skills/doc-checker/scripts/doc_check.py {ファイルパス}
チェック内容
用語の統一
| 誤った表記 | 正しい表記 |
|---|---|
| Javascript | JavaScript |
| Github | GitHub |
| Typescript | TypeScript |
必須セクション
以下のセクションが含まれているか確認:
## 概要## 使い方## 注意事項
使用例
ユーザー: 「sample-doc.mdをチェックして修正して」
AI: スクリプトでチェックを実行
→ 問題を検出
→ 修正を実施
→ 再チェックで確認