DeepDocs

DeepDocsは、コードベースと完全に同期した技術ドキュメントを維持するGitHubのAIエージェントです。コードの変更をコミットすると、リポジトリ全体をスキャンして更新が必要なドキュメントを見つけ、自動的に必要な変更を行います。

従来のドキュメントジェネレーターがファイルを一から作成するのとは異なり、DeepDocsは変更が必要なセクションのみを更新し、元のスタイルやフォーマットを保持します。Docusaurus、Mintlify、MkDocs、Read the Docsなどの人気ドキュメントツールに対応しています。

DeepDocsは、個人プロジェクト向けに月10回のスキャンクレジットが付いた無料版を提供しており、頻繁にコードをリリースするチーム向けには月100回のスキャンクレジットと、最大5つのドキュメントファイルまたはフォルダーを同時にサポートするPro版があります。

DeepDocsの始め方は簡単で、約2分で完了します。手順は以下の通りです：

• GitHub Marketplaceから、ソースコードとドキュメントを含むリポジトリにDeepDocsアプリケーションをインストールします。ドキュメントが別のリポジトリにある場合は、そちらにもインストールしてください。

• メインブランチのルートにdeepdocs.ymlという設定ファイルを作成します。このファイルは、DeepDocsにどのドキュメントファイルやフォルダをコードと同期させたいかを指示します。

• 設定ファイルをリポジトリにコミットします。DeepDocsはすぐにコードベースの完全なスキャンを実行し、古くなったドキュメントを検出して、修正案を含む詳細なメールレポートを送信します。

• 初期設定後、DeepDocsは以降のすべてのコミットで自動的に動作し、変更をスキャンして関連するドキュメントを別のブランチで更新し、マージ前にレビューできるようにします。

• コミットごとの自動ドキュメント更新

• コード変更ごとのリポジトリ全体スキャン

• フォーマットを維持しながら古い部分のみを更新

• ドキュメント変更の詳細レポート

• プルリクエストワークフローに対応したGitHubネイティブ統合

• モノレポおよび別々のドキュメントリポジトリに対応

• Docusaurus、Mintlify、MkDocs、Read the Docsをサポート

• 全文書き換えなしのインテリジェントな更新

• スキャン結果のメール通知

• 簡単な2分間セットアッププロセス