# バッチ設計書 18-rake doc:clean

## 概要

本ドキュメントは、mrubyプロジェクトにおいて生成済みドキュメントを全て削除する`rake doc:clean`タスクのバッチ設計書である。

### 本バッチの処理概要

`rake doc:clean`は、`rake doc:api`および`rake doc:capi`で生成されたドキュメントファイルを全て削除するRakeタスクである。`doc:clean:api`と`doc:clean:capi`の2つのサブタスクに依存し、YARDドキュメント（doc/api/、.yardoc/）とDoxygenドキュメント（doc/capi/）の両方を削除する。

**業務上の目的・背景**：生成されたドキュメントをクリーンアップし、ディスクスペースを解放するため、またはドキュメントの再生成前に古いファイルを確実に除去するために使用される。`rake deep_clean`タスクからも呼び出され、プロジェクト全体のクリーンアップの一部として機能する。

**バッチの実行タイミング**：開発者による手動実行。ドキュメントの完全な再生成前や、不要なファイルのクリーンアップ時に実行される。`rake deep_clean`からも間接的に実行される。

**主要な処理内容**：
1. `doc:clean:api`の実行：doc/api/ディレクトリと.yardoc/ディレクトリの削除
2. `doc:clean:capi`の実行：doc/capi/ディレクトリの削除

**前後の処理との関連**：`rake deep_clean`タスクの依存タスクとして呼び出される。後続処理としては`rake doc`によるドキュメントの再生成が想定される。

**影響範囲**：doc/api/、.yardoc/、doc/capi/の3つのディレクトリが再帰的に削除される。ソースコードやビルド成果物には影響しない。

## バッチ種別

クリーンアップ処理（ドキュメント削除）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 / rake deep_clean経由 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Ruby実行環境 | Rubyインタプリタがインストールされていること |
| Rakeインストール | Rakeがインストールされていること |

### 実行可否判定

削除対象のディレクトリが存在しない場合でも、`rm_rf`コマンドにより処理はエラーなく完了する（存在チェックは不要）。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本タスクにパラメータはない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| doc/api/ | ディレクトリ | 削除対象のYARDドキュメント |
| .yardoc/ | ディレクトリ | 削除対象のYARDキャッシュ |
| doc/capi/ | ディレクトリ | 削除対象のDoxygenドキュメント |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ファイルシステム | 削除操作 | 3つのディレクトリが再帰的に削除される |

### 出力ファイル仕様

本バッチはファイルを出力しない。ディレクトリの削除のみを行う。

## 処理フロー

### 処理シーケンス

```
1. doc:clean:apiの実行
   └─ rm_rf %w(doc/api .yardoc)
   └─ doc/api/ディレクトリと.yardoc/ディレクトリを再帰削除
2. doc:clean:capiの実行
   └─ rm_rf 'doc/capi'
   └─ doc/capi/ディレクトリを再帰削除
```

### フローチャート

```mermaid
flowchart TD
    A[rake doc:clean 開始] --> B[doc:clean:api 実行]
    B --> C[rm_rf doc/api .yardoc]
    C --> D[doc:clean:capi 実行]
    D --> E[rm_rf doc/capi]
    E --> F[完了]
```

## データベース操作仕様

### 操作別データベース影響一覧

本バッチはデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | 権限エラー | 削除対象ディレクトリに対する書き込み権限がない場合 | ファイル権限を確認・修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

権限エラーが発生した場合は、対象ディレクトリのファイル権限を確認し、必要に応じて手動で削除する。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A（削除されたファイルは復元不可） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 削除対象ファイル数に依存 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時実行に対する制限はないが、ドキュメント生成中の削除は避けるべきである。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | 特にログ出力は行われない |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理完了 | N/A | 手動確認 |

## 備考

- `rm_rf`はRubyのFileUtilsメソッドであり、対象が存在しない場合でもエラーにならない
- `rake deep_clean`タスクの依存タスクとして組み込まれている（Rakefile L70: `task :deep_clean => %w[clean doc:clean]`）
- 非推奨エイリアス`clean_doc`、`clean_api_doc`、`clean_capi_doc`も利用可能
- 削除されたドキュメントは`rake doc`で再生成可能
