Skip to content
/ DocCraftPro Public

DocCraft Pro - AIドキュメント自動生成CLI Gemini 2.5 / Claude Code CLIを活用した、システム開発ドキュメント自動生成ツール。 要件定義、テストケース、QAなどを高品質に生成。Shift-JIS完全対応。

1 star 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

cruzyjapan/DocCraftPro

BranchesTags

Repository files navigation

AI Dev Tool

AI Dev Tool（ai-dev）は、Gemini CLIやClaude Code CLIを活用して、システム開発に必要な各種ドキュメントを自動生成するコマンドラインツールです。

📦 GitHub Repository: https://github.com/cruzyjapan/DocCraftPro

✨ 主な機能

ドキュメント生成

  • 📝 要件定義書の自動生成 - プロジェクトの説明から詳細な要件を生成
  • ✅ テストケースの作成 - 機能要件に基づいたテストケースを自動作成
  • 📋 タスクリストの生成 - 開発タスクを優先度付きで整理
  • ❓ Q&Aドキュメント - よくある質問と回答を自動生成
  • 🎯 テスト概念書 - テスト戦略とアプローチを文書化

ファイル解析

  • 📝 テキスト/Markdown解析 - 構造とセクションの分析（✅ 利用可能）
  • 📊 Excel/CSV分析 - データの統計情報と構造を解析（🚧 開発中/テスト中）
  • 📑 PowerPoint解析 - スライド内容とテーブルの抽出（🚧 開発中/テスト中）
  • 📄 PDF解析 - テキストとメタデータの抽出（🚧 開発中/テスト中）

📋 必要な環境

  • Ubuntu/Debian系のLinux (WSL2も可)
  • Python 3.10以上（推奨: Python 3.12）
  • sudoの実行権限（python3-venvインストール用）
  • Node.js 18以上（AI CLIツール用）
  • 以下のいずれか：
    • Gemini CLI（Google AI）
    • Claude CLI（Anthropic）

🚀 クイックスタート（初めての方向け）

完全な手順（GitHubからクローンする場合）

# 1. リポジトリをクローン
git clone https://github.com/cruzyjapan/DocCraftPro.git
cd DocCraftPro

# 2. スクリプトに実行権限を付与
chmod +x setup.sh activate.sh

# 3. セットアップを実行
bash setup.sh

# セットアップ中の対話的プロンプト:
# - 「Configuration file already exists. Overwrite? [y/N]:」→ N を押してEnter
# - 「Would you like to test ai-dev now? (Y/n):」→ Y を押してEnter（任意）

# 4. ai-devコマンドを有効化（以下のいずれか）
source ~/.bashrc        # エイリアスを読み込む（推奨）
# または
source activate.sh      # 仮想環境を有効化

# 5. 動作確認
ai-dev status
ai-dev --help

すでにクローン済みの場合

# 1. 必要なパッケージをインストール
sudo apt update
sudo apt install -y python3.12-venv

# 2. セットアップを実行
bash setup.sh

# 3. ai-devを有効化して使用
source ~/.bashrc && ai-dev status

これで準備完了です！🎉

📦 詳細なインストール方法

方法1: 自動セットアップ（推奨）

# 1. python3-venvをインストール
sudo apt update
sudo apt install -y python3.12-venv

# 2. 自動セットアップスクリプトを実行
bash setup.sh

# このスクリプトは以下を自動で行います：
# - python3-venvのインストール（sudo必要）
# - Python仮想環境の作成
# - 必要なパッケージのインストール
# - ai-devツールのインストール
# - 設定ファイルの初期化
# - ~/.bashrcにエイリアスを自動追加
# - 対話的なテストプロンプトを表示

# 3. セットアップ完了後、表示されたコマンドを実行
source ~/.bashrc && ai-dev status

方法2: Makefileを使用

# 1. python3-venvをインストール
sudo apt install -y python3.12-venv

# 2. Makeコマンドで初期化
make init

方法3: 手動インストール

# 1. python3-venvをインストール
sudo apt install -y python3.12-venv

# 2. Python仮想環境を作成
python3 -m venv venv

# 3. 仮想環境を有効化
source venv/bin/activate

# 4. pipをアップグレード
pip install --upgrade pip

# 5. 必要なパッケージをインストール
pip install -r requirements.txt

# 6. ツールをインストール
pip install -e .

# 7. 初期設定
ai-dev init

方法4: sudoを使わない方法

# virtualenvを使った方法（sudoが不要）
bash setup_nosudo.sh

🔧 トラブルシューティング

⏱️ タイムアウトエラーが発生する場合

→ TIMEOUT_GUIDE.md を参照

クイックフィックス:

# カスタムタイムアウト設定（10分）
ai-dev --timeout 600 generate requirements input.txt -e utf-8

エラー: "python3-venv is not installed"

このエラーが出た場合：

# Python 3.12の場合
sudo apt install python3.12-venv

# Python 3.11の場合
sudo apt install python3.11-venv

# Python 3.10の場合
sudo apt install python3.10-venv

エラー: "setup.sh: command not found"

# bashで実行
bash setup.sh

# または実行権限を付与してから実行
chmod +x setup.sh
./setup.sh

エラー: "ai-dev: command not found"

# 解決方法1: bashrcを再読み込み（エイリアス設定済みの場合）
source ~/.bashrc
ai-dev --help

# 解決方法2: activate.shスクリプトを使用
source activate.sh
ai-dev --help

# 解決方法3: 手動で仮想環境を有効化
source venv/bin/activate
ai-dev --help

# 解決方法4: 仮想環境内で再インストール
source venv/bin/activate
pip install -e .

Pythonバージョンの確認

# Pythonのバージョンを確認
python3 --version

# 3.10以上であることを確認してください

🎯 基本的な使い方

1. ai-devコマンドの実行

# setup.shでエイリアスが設定済みの場合（推奨）
ai-dev --help

# エイリアスが未設定の場合は、まず以下を実行
source ~/.bashrc
ai-dev --help

# または便利スクリプトを使用（仮想環境を自動的に有効化）
source activate.sh
ai-dev --help

# または手動で仮想環境を有効化
source venv/bin/activate
ai-dev --help

2. ドキュメントを生成

# 1. 入力テキストファイルを作成
echo "ユーザー認証システムの開発" > my_project.txt

# 2. 要件定義書を生成（UTF-8推奨）
ai-dev generate requirements my_project.txt -o my_requirements.md -e utf-8

# 3. 他の形式でも出力可能
ai-dev generate requirements my_project.txt -f json -e utf-8
ai-dev generate requirements my_project.txt -f csv -e utf-8
ai-dev generate requirements my_project.txt -f html -e utf-8

重要: 日本語環境では -e utf-8 オプションの使用を推奨します。

📝 コマンド一覧

基本コマンド

コマンド 説明
ai-dev --help ヘルプを表示
ai-dev status 現在の設定状態を表示
ai-dev init 初期設定を作成

ファイル解析コマンド

コマンド 説明 例 対応状況
analyze file テキストファイルを解析 ai-dev analyze file input.txt ✅ 利用可能
analyze file Excel/CSVを解析 ai-dev analyze file data.csv 🚧 開発中
analyze file PowerPointを解析 ai-dev analyze file slides.pptx 🚧 開発中
analyze file PDFを解析 ai-dev analyze file doc.pdf 🚧 開発中
--extract-text テキストのみ抽出 ai-dev analyze file input.txt --extract-text ✅ 利用可能

ドキュメント生成コマンド

コマンド 説明 例
generate requirements 要件定義書を生成 ai-dev generate requirements input.txt
generate qa QAドキュメントを生成 ai-dev generate qa input.txt
generate tasks タスクリストを生成 ai-dev generate tasks input.txt
generate test-concept テスト概念書を生成 ai-dev generate test-concept input.txt
generate test-cases テストケースを生成 ai-dev generate test-cases input.txt

オプション

オプション 説明 例
-o, --output 出力ファイル名を指定 -o output.md
-f, --format 出力形式を指定 -f json
-e, --encoding 文字エンコーディングを指定 -e utf-8

出力形式

  • md または markdown - Markdown形式（デフォルト）
  • json - JSON形式
  • csv - CSV形式
  • html - HTML形式

🔄 AIモデルの切り替え

サポートされているAIモデル

モデル 提供元 特徴 インストールコマンド
Gemini Google 高速、日本語対応良好 npm install -g @google/generative-ai-cli
Claude Anthropic 高品質、詳細な出力 Claude公式ツールを使用

モデルの切り替え

# 現在のAIモデルを確認
ai-dev status

# Geminiに切り替え
ai-dev use gemini

# Claudeに切り替え
ai-dev use claude

# 一時的に特定のモデルを使用
ai-dev --ai claude generate requirements input.txt -e utf-8

AIモデルのセットアップ

ai-devツールが動作するためには、GeminiまたはClaudeのCLIツールが必要です。 詳細はClaude Setup Guideを参照してください。

🛠️ 開発者向けコマンド

Makefileコマンド

make help          # ヘルプを表示
make init          # 完全初期化
make install       # 依存関係のインストール
make install-dev   # 開発用依存関係もインストール
make test          # テストを実行
make format        # コードをフォーマット
make lint          # リントチェック
make clean         # 一時ファイルを削除
make clean-all     # 全てクリーンアップ（venv含む）

📁 プロジェクト構成

DocCraftPro/
├── setup.sh           # 自動セットアップスクリプト
├── activate.sh        # 仮想環境有効化ヘルパースクリプト
├── .init.sh           # 旧セットアップスクリプト（非推奨）
├── requirements.txt   # Pythonパッケージ一覧
├── setup.py          # パッケージ設定
├── Makefile          # Make コマンド定義
├── src/
│   └── ai_dev/       # メインソースコード
│       ├── cli.py    # CLIコマンド
│       ├── generators/   # ドキュメント生成器
│       ├── ai_models/    # AIモデルラッパー
│       └── utils/        # ユーティリティ
├── config/
│   └── default.yaml  # デフォルト設定
├── output/           # 生成されたドキュメント（自動作成）
└── venv/            # Python仮想環境（自動作成）

⚠️ 既知の問題と対処法

AI CLIツールのインストール

GeminiまたはClaude CLIは別途インストールが必要です：

# Gemini CLI (Node.jsが必要)
npm install -g @google/generative-ai-cli

# Claude CLI（Anthropicの公式ツールを使用）
# https://docs.anthropic.com/claude/docs を参照

エンコーディングについて

日本語を含むドキュメントを生成する場合は、必ず -e utf-8 オプションを使用してください：

# 正しい使い方
ai-dev generate requirements input.txt -e utf-8

# デフォルト（Shift-JIS）では文字化けする可能性があります

❓ よくある質問

Q: 「Items: 0」と表示される

A: Gemini CLIが正しくインストールされているか確認してください。また、入力ファイルの内容が短すぎる可能性があります。

Q: sudoパスワードを入力したくない

A: bash setup_nosudo.shを使用してください。virtualenvを使った方法でインストールできます。

Q: Windows で使いたい

A: WSL2（Windows Subsystem for Linux）を使用してください。WSL2のUbuntu環境で上記の手順を実行できます。

Q: 仮想環境を有効化し忘れる

A: setup.shを実行すると、自動的にエイリアスが設定されます。または手動で.bashrcに以下を追加できます：

# .bashrcに追加（setup.shで自動設定済み）
alias ai-dev='source ~/DEV/self-directed_ai_team_development/DocCraftPro/venv/bin/activate && ai-dev'

# または、ディレクトリに入った時に自動で有効化
cd() {
    builtin cd "$@"
    if [ -f venv/bin/activate ]; then
        source venv/bin/activate
    fi
}

Q: 生成されたドキュメントの文字化け

A: 必ず -e utf-8 オプションを使用してください：

# 推奨: UTF-8で出力
ai-dev generate requirements input.txt -e utf-8

# Shift-JISは特殊な場合のみ使用
ai-dev generate requirements input.txt -e shift-jis

📄 ライセンス

MIT License

🤝 貢献

プルリクエストを歓迎します。大きな変更の場合は、まずissueを開いて変更内容について議論してください。

📞 サポート

問題や質問がある場合は、GitHub Issuesページを使用してください。

About

DocCraft Pro - AIドキュメント自動生成CLI Gemini 2.5 / Claude Code CLIを活用した、システム開発ドキュメント自動生成ツール。 要件定義、テストケース、QAなどを高品質に生成。Shift-JIS完全対応。

Resources

Readme
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

No packages published

Contributors 2

  •  
  •  

Languages