Autodocument

🚀 管理ツール

この管理ツールは、コードベースの技術文書生成、自動テスト計画生成、自動コードレビューなどの機能を提供し、開発者の作業効率を大幅に向上させます。

🚀 クイックスタート

✨ 主な機能

この管理ツールには以下の核心機能が含まれています：

• 文書生成：コードベースに対して包括的な技術文書を生成します。
• 自動テスト計画生成：コード内の関数やコンポーネントに対して詳細なテスト計画を自動生成します。
• 自動コードレビュー：上級開発者レベルのコードレビューフィードバックを提供します。

📦 インストール

インストールガイド

以下の手順に従ってインストールしてください：

1. このリポジトリをローカルマシンにクローンします。
2. npmまたはyarnを使用して依存関係をインストールします。
3. 環境変数を設定します。特にOPENROUTER_API_KEYを設定する必要があります。

環境変数

以下は設定が必要な主要な環境変数です：

💻 使用例

基本的な使用法

文書生成

このツールは包括的なコードベースの技術文書を生成できます：

{
  "path": "/路径/到/你的/项目",
  "openRouterApiKey": "你的-api-密钥", // オプションパラメータ
  "model": "anthropic/claude-3-7-sonnet", // オプションパラメータ
  "updateExisting": true // オプション、デフォルトはtrue
}

自動テスト計画生成

このツールは詳細なテスト計画を生成できます：

{
  "path": "/路径/到/你的/项目",
  "openRouterApiKey": "你的-api-密钥", // オプションパラメータ
  "model": "anthropic/claude-3-7-sonnet", // オプションパラメータ
  "updateExisting": true // オプション、デフォルトはtrue
}

自動コードレビュー

このツールは専門レベルのコードレビューフィードバックを提供します：

{
  "path": "/路径/到/你的/项目",
  "openRouterApiKey": "你的-api-密钥", // オプションパラメータ
  "model": "anthropic/claude-3-7-sonnet", // オプションパラメータ
  "updateExisting": true // オプション、デフォルトはtrue
}

📚 ドキュメント

出力ファイルの説明

文書出力

生成される主要な文書タイプには以下が含まれます：

• documentation.md：コードベースの包括的な技術文書を含み、内容は以下をカバーします：
  • コードの目的と役割
  • 主要な関数とクラスの詳細な説明
  • ファイル間の関係の説明
  • サブコンポーネントの統合情報
• testplan.md：詳細なテスト計画を含み、内容は以下を含みます：
  • 各関数に適したテストタイプ（単体テスト、統合テスト、エンドツーエンドテスト）
  • 一般的な境界条件の分析
  • 依存関係のモッキング要件
  • 統合テスト戦略の提案
• review.md：上級開発者レベルのレビューフィードバックを提供し、内容は以下をカバーします：
  • セキュリティ上の危険性と潜在的な脆弱性
  • コーディング規約の違反ポイント
  • 潜在的なバグまたはアーキテクチャ上の問題
  • 改善の機会とリファクタリングの提案
  • 実用的な改善提案（スタイルの微調整を避ける）

予備ファイル

ディレクトリがサイズまたはファイル数の制限を超えた場合、以下の予備ファイルが生成されます：

• undocumented.md：文書生成プロセスで処理されなかった内容を格納し、以下を含みます：
  • 処理を無視した理由の説明
  • 分析されたが除外されたファイルのリスト
  • 問題を解決する方法のガイダンス（制限を増やすか、手動で内容を作成するなど）

問題解決

APIキー関連の問題

APIキーが無効なエラーが発生した場合は、以下のチェックを行ってください：

1. OPENROUTER_API_KEY環境変数が設定されていることを確認します。
2. OpenRouterアカウントがアクティブであることを確認します。
3. 十分なAPI呼び出しクォータがあることを確認します。

サイズ制限の問題

ディレクトリが大きすぎるか、ファイル数が多すぎるために処理が失敗した場合は、以下の操作を行ってください：

1. MAX_FILE_SIZE_KBとMAX_FILES_PER_DIR環境変数を調整して制限を増やします。
2. 非常に大きなディレクトリについては、手動で文書を作成することを検討します。

モデル選択の問題

生成結果の品質に満足しない場合は、モデルを変更してみてください：

• OPENROUTER_MODEL環境変数を必要な他のモデル名に設定します。

📄 ライセンス

このプロジェクトはCC0-1.0ライセンスを採用しており、作品の著作権は公共ドメインに帰属し、米国エネルギー省が所有しています。

貢献ガイド

開発者の皆様からの積極的な貢献を歓迎します！自由にPull Requestを送信してください。

新しい機能モジュールの追加

新しい自動化ツールを追加するには、以下の手順に従ってください：

1. src/toolsディレクトリに新しいツールクラスファイルを作成します。
2. 対応するビジネスロジックとインターフェースの適合を実装します。
3. メインプログラムを更新して新しい機能の呼び出しをサポートします。