AutoDocsは、MCPサーバーを内蔵したオープンソースのコードドキュメント自動化ツールです。

AutoDocsとは何ですか？

TrySitaが開発したAutoDocsは、開発者がコードベースのドキュメントを効率的に生成・保守できるオープンソースのコードドキュメント自動化ツールです。コードベースの抽象構文木（AST）と依存関係グラフを詳細に解析することで、正確かつ依存関係を考慮したドキュメントと要約を生成します。AutoDocsはTypeScript、JavaScript、Pythonなど複数のプログラミング言語をサポートしており、今後さらに多くの言語に対応していく予定です。データ取り込みと検索のためのFastAPIバックエンドと、ドキュメントの閲覧・探索のためのNext.jsウェブUIを提供します。また、組み込みのMCPサーバーも搭載しており、インテリジェントなツールがHTTP経由で詳細な検索を実行できます。

AutoDocsの主な機能

コードベースの詳細な分析コードベースはtree-sitterとSCIPを使用して解析され、依存関係グラフが構築され、依存関係の順序でドキュメントが生成されます。
多言語対応TypeScript、JavaScript、Pythonをサポートしており、Go、Kotlin、Java、Rustへのサポートも拡大中です。
文書の自動生成と更新リポジトリレベルで依存関係を考慮したドキュメントと概要を自動的に生成し、コード変更後に自動的に更新します。
内蔵MCPサーバー高度な検索のためのインテリジェントツールをサポートするHTTPインターフェースを提供します。
Web UIの探索Next.jsのWeb UIを提供し、ドキュメントの閲覧や探索を容易にします。
柔軟な統合Dockerによる迅速なデプロイをサポートしており、既存のプロジェクトへの統合も容易です。

AutoDocsの技術的原理

抽象構文木（AST）の解析tree-sitterを使用してコードを解析し、コード構造と意味情報を取得します。
シンボリック情報プロトコル（SCIP）SCIPは、コード内のシンボル情報を解析して依存関係グラフを構築するために使用されます。
依存関係グラフの構築ASTとSCIPの解析結果に基づいて、ファイル、定義、呼び出し、インポートの関係を含むコード依存関係グラフが構築されます。
文書生成依存関係グラフに基づいて、リポジトリレベルの依存関係を考慮したドキュメントと要約を生成し、ドキュメントの正確性と高いシグナル強度を確保します。
FastAPIバックエンドデータ取り込み機能と検索機能を提供し、ドキュメントの動的な生成とクエリをサポートします。
Next.js Web UI生成されたドキュメントをユーザーが閲覧・探索するのに役立つユーザーインターフェースを提供します。
MCPサーバー内蔵のMCPサーバーにより、インテリジェントツールはHTTPインターフェースを介して詳細な検索を実行できます。
DockerデプロイメントDockerとDocker Composeを介したローカル展開ソリューションを提供するため、簡単にセットアップして迅速に使用できます。

AutoDocsプロジェクトのアドレス

GitHubリポジトリ：https://github.com/TrySita/AutoDocs

AutoDocs アプリケーションシナリオ

アジャイル開発チーム開発環境が急速に反復される状況では、AutoDocsはドキュメントの生成と更新を自動化し、ドキュメントを手動で維持する作業量を削減するとともに、ドキュメントとコードの同期を確保します。
大規模エンタープライズアプリケーション複数のチームが協力して取り組む大規模プロジェクトにおいて、AutoDocsは高品質なコードドキュメントを生成し、異なるチーム間の理解と協力を促進することができます。
継続的インテグレーションプロセス継続的インテグレーション（CI）プロセスに統合することで、コードコミット後にドキュメントを自動的に更新し、ドキュメントが常に最新のプロジェクト状況を反映するようにします。
プロジェクトの展示とメンテナンスオープンソースプロジェクトや公開コードリポジトリでは、AutoDocsはREADMEファイルやその他のドキュメントを自動的に生成し、プロジェクトの可読性と魅力を向上させることができます。