# コードドキュメント(docstring/JSDoc)自動生成 — 運用ガイド

## 基本情報

| 項目 | 内容 |
|------|------|
| 業種 | IT・開発 |
| ユースケース | コードドキュメント(docstring/JSDoc)自動生成 |
| WFパターン | `start → llm(言語判定+ドキュメント生成) → end` |
| RAG | なし |
| 検証結果 | E2E pass |
| デモURL例 | http://localhost/workflow/AJRmPUWVCj7yY1js |

## 概要

ドキュメント未整備のコードを入力として、言語に応じたドキュメントコメントを生成する。

## デモ手順

1. DDF Web UI (`/dashboard`) を開く
2. 「コードドキュメント(docstring/JSDoc)自動生成」の「デモ生成」ボタンをクリック
3. 業種「IT・開発」、UC「コードドキュメント(docstring/JSDoc)自動生成」が自動入力される
4. 「デモ生成開始」をクリック
5. 生成完了後、デモURLを顧客に共有


## テスト入力例

### 入力例1
```
```python
def calculate_compound_interest(principal, rate, n, t):
    amount = principal * (1 + rate / n) ** (n * t)
    return round(amount - principal, 2)

def apply_tax(price, tax_rate=0.10, reduced=False):
    if reduced:
        tax_rate = 0.08
    tax = price * tax_rate
    return {'price': pr
```


## 顧客への説明ポイント

- 「これは自動生成されたプロトタイプです。本番利用には追加の設計・開発が必要です」
- 「御社の実データ/ドキュメントを使えば、さらに精度の高いデモをお見せできます」
- 「Self-hostedなので、御社のデータは外部に出ません」

## AI品質評価コメント

ユースケース要件に完全に合致しており、入力されたPython関数（`calculate_compound_interest`と`apply_tax`）に対して、Google Style docstringが適切に生成されています。docstringは説明、引数、戻り値、例外、使用例といった必要な要素を全て網羅しており、内容も正確かつ高品質です。汎用的なテンプレートではなく、各関数のロジックと引数に基づいて具体的に記述されており、顧客デモとして十分見せられる品質です。

## 次のステップ（受託提案）

1. 顧客の実データでカスタマイズデモ（POC: 5-10万円）
2. 本番環境設計・構築（受託開発）
3. 既存システム（kintone/Salesforce等）とのAPI連携
4. 運用保守サポート