Autodocument

🚀 Autodoc 自動化ドキュメントツール

Autodocは、コードベースのドキュメント、テスト計画、コードレビューを自動生成するツールです。これにより、開発者は手間を省き、効率的に開発作業を進めることができます。

🚀 クイックスタート

📦 インストール

リリースページにアクセスし、お使いのオペレーティングシステムに適したインストールパッケージをダウンロードしてください。

🔧 環境変数の設定

初回実行前に、以下の環境変数を設定してください。

• OPENROUTER_API_KEY：OpenRouterから取得した有効なAPIキー。
• MAX_FILE_SIZE_KB（オプション）：各ディレクトリで処理する最大ファイルサイズ（KB）。デフォルト値は51200です。
• MAX_FILES_PER_DIR（オプション）：各ディレクトリで処理できる最大ファイル数。デフォルト値は200です。

💻 使用例

基本的な使用法

インストールが完了したら、以下のコマンドを実行してツールを起動します。

node /path/to/autodoc/build/index.js

高度な使用法

ツールを呼び出す例を以下に示します。

自動ドキュメント生成

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "generate_documentation",
    "arguments": {
      "path": "/path/to/project",
      "openRouterApiKey": "your-api-key-here"
    }
  },
  "id": 1
}

自動テスト計画生成

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "autotestplan",
    "arguments": {
      "path": "/path/to/project",
      "openRouterApiKey": "your-api-key-here"
    }
  },
  "id": 1
}

自動コードレビュー生成

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "autoreview",
    "arguments": {
      "path": "/path/to/project",
      "openRouterApiKey": "your-api-key-here"
    }
  },
  "id": 1
}

✨ 主な機能

自動ドキュメント生成（generate_documentation）

コードベースに対して包括的なドキュメントを生成します。

• 入力パラメータ:
  • path：必須。処理対象のプロジェクトのパスを指定します。
  • openRouterApiKey：オプション。OpenRouter APIキーを提供します。デフォルトでは環境変数から読み取ります。
  • model：オプション。デフォルトでは "anthropic/claude-3-7-sonnet" モデルを使用します。
  • updateExisting：オプション。デフォルトはtrueで、既存のドキュメントファイルを上書きします。

自動テスト計画生成（autotestplan）

コードベースに対して詳細なテスト計画を生成します。

• 入力パラメータ:
  • path：必須。処理対象のプロジェクトのパスを指定します。
  • openRouterApiKey：オプション。OpenRouter APIキーを提供します。デフォルトでは環境変数から読み取ります。
  • model：オプション。デフォルトでは "anthropic/claude-3-7-sonnet" モデルを使用します。
  • updateExisting：オプション。デフォルトはtrueで、既存のテスト計画ファイルを上書きします。

自動コードレビュー生成（autoreview）

コードベースに対して高度な開発者のレビューフィードバックを生成します。

• 入力パラメータ:
  • path：必須。処理対象のプロジェクトのパスを指定します。
  • openRouterApiKey：オプション。OpenRouter APIキーを提供します。デフォルトでは環境変数から読み取ります。
  • model：オプション。デフォルトでは "anthropic/claude-3-7-sonnet" モデルを使用します。
  • updateExisting：オプション。デフォルトはtrueで、既存のレビューフィードバックファイルを上書きします。

📚 ドキュメント

出力ファイルの説明

ツールを実行すると、指定されたディレクトリに以下のファイルが生成されます。

一般的な問題の解決

エラーコードの説明

• ERROR_API_KEY_INVALID：APIキーが無効または期限切れです。
• ERROR_PATH_NOT_FOUND：指定されたパスが存在しないか、アクセスできません。
• ERROR_FILE_SIZE_EXCEEDED：ファイルサイズが制限を超えています。
• ERROR_MAX_FILES_REACHED：処理するファイル数が上限に達しました。

エラーログの確認

ツールの実行中には、コンソールにリアルタイムログが出力されます。実行が完了または中断された後、autodoc.log ファイルにすべての操作とエラー情報が記録されます。

🤝 プロジェクトへの貢献

オープンソースコミュニティの構築にご参加いただけることを歓迎します！GitHubリポジトリにアクセスして、問題の報告、機能要求、コードの貢献を行ってください。

⚠️ 重要提示

このツールを使用する前に、関連するドキュメントと技術仕様をよく読み、理解してから使用してください。これにより、最適な使用体験を得ることができます。