187 lines
5.8 KiB
Markdown
187 lines
5.8 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 ルールプリセットです。
|