DeepDocs：コードドキュメントを自動更新するGitHubのAIツール

DeepDocsはGitHubベースのAIツールで、煩雑なコードドキュメントの更新の問題を解決することに焦点を当てています。コードの変更をインテリジェントに分析することで、README、APIリファレンス、チュートリアルなどのプロジェクト・ドキュメントを自動的に更新し、コードとの同期を確保します。DeepDocsは、追加のプラットフォームを必要とせずにGitHubワークフローに統合されるため、迅速な開発チームに最適です。コードベース全体をスキャンし、古くなったドキュメントを特定し、形式やスタイルを変えることなく正確に更新します。また、DeepDocsはプライバシーを重視しており、コードは実行時に一時的に処理されるだけで、保存されることはない。

機能一覧

• 継続的なドキュメントの更新コードのコミットごとに、影響を受けるドキュメントを自動的に検出して更新します。
• ディープスキャンコードベースを完全に分析し、古くなったドキュメントを一括修正する。
• インテリジェントエディタ文書の必要な部分のみを更新し、元の構成とスタイルを維持する。
• 詳細レポートドキュメント更新の理由と、関連するコードコミットを記述した変更レポートを作成します。
• GitHubネイティブ統合GitHubのワークフローに直接組み込み、ドキュメントの更新をコミットするために別のブランチを作成します。
• 複数の文書タイプをサポートREADME、APIリファレンス、SDKガイド、チュートリアルなどに対応。
• プライバシーコード処理は一時的で保存されないため、データの安全性が保証されます。

ヘルプの使用

設置プロセス

DeepDocsは、GitHubを使用している開発チームであれば、インストールと設定が非常に簡単です。以下は、詳細なインストール手順です：

1. DeepDocs GitHub アプリのインストール
   GitHub リポジトリを開き Settings > GitHub Apps.GitHub Marketplaceを検索する DeepDocsAIクリック Configure.監視する必要があるコードリポジトリを選択します（ドキュメントが別のリポジトリにある場合は、そのリポジトリにもインストールする必要があります）。をクリックしてください。 Save 設定を保存します。さらにリポジトリを追加する必要がある場合は、後で GitHub の Installation Settings ミディアム調整。
2. 設定ファイルの作成
   コード・リポジトリーのルート・ディレクトリーに deepdocs.yml ファイルで設定します。以下は基本的なコンフィギュレーションの例である：

   target:
   - url: "docs/"
   reinit: "random-string"
   ignore: []
   

   • target監視するドキュメントフォルダまたはファイルパスを指定します。 docs/.
   • reinitデプススキャンを手動でトリガーするためのランダムな文字列。
   • ignore無視するファイルやフォルダを指定します（オプション）。
     このファイルを監視対象のブランチにコミットする（例 main もしかしたら dev).
3. 初回スキャンのトリガー
   だす deepdocs.yml その後、DeepDocsは自動的にディープスキャンを実行し、コードベース全体を分析し、古いドキュメントを更新します。結果は deepdocs-deepscan-<branch>-<commit_sha>を更新した。

主要機能の使用

継続的なドキュメントの更新

DeepDocs の中核機能は、ドキュメントの継続的な更新です。各コードのコミット (プッシュまたはプル・リクエスト) 後、DeepDocs は自動的にコードの変更をスキャンし、更新が必要なドキュメントを決定します。例えば、API エンドポイントが変更されると、DeepDocs は関連する API リファレンス・ドキュメントを更新します。更新は、新しいブランチ ( deepdocs-update-<branch>-<commit_sha>)の詳細な変更レポートが含まれています。ユーザーはこれらの更新を GitHub 上で直接確認し、マージすることができます。

ディープスキャン

ディープスキャンは、大量の古くなった文書の処理に適している。ユーザーは deepdocs.yml 正鵠を得る reinit DeepDocs は、コードベース全体を検査し、更新が必要なすべてのドキュメントを識別し、すべての変更を含むブランチを生成します。レポートには、更新されたドキュメント、変更の理由、および関連するコード・コミットが一覧表示されます。

インテリジェントな編集とレポート

DeepDocs は、AI を使用して、ドキュメントに関連するコードを分析し、必要な部分のみを更新します。例えば、関数のシグニチャが変更された場合、DeepDocs は、ファイル全体を書き換えることなく、関連するドキュメントの説明のみを更新します。更新のたびに、どのドキュメントが変更されたか、その理由、および関連するコード・コミットを記述したレポートが生成されます。これにより、チームは更新の正確性を迅速に検証できます。

GitHubネイティブ統合

DeepDocsは、追加ツールなしでGitHubワークフローに直接組み込むことができます。GitHub Actionsを通じて実行され、プル・リクエストとコード・コミットを監視します。更新されたドキュメントはプルリクエストとして提出され、チームのレビューが容易になります。ユーザーは GitHub を離れることなく、すべての作業を行うことができます。

ワークフロー

1. コードを送信開発者は通常、GitHubのリポジトリにコードをコミットする。
2. 自動検出DeepDocsはコードの変更を検出し、ドキュメントへの影響を分析します。
3. アップデートの生成DeepDocs は、更新されたドキュメントとレポートを新しいブランチにコミットします。
4. 見直しと統合チームはGitHubでプルリクエストを確認し、それを確認してマージする。
5. マニュアル・デプス・スキャン(オプション）：修正 reinit この文字列は、ドキュメントの完全な修正をトリガーする。

ほら

• ドキュメントとコードが異なるリポジトリにある場合、DeepDocs アプリが両方のリポジトリにインストールされていることを確認します。 deepdocs.yml.
• DeepDocs は新しいドキュメントを生成しません。 ギットハブ・コパイロット (創作）。
• ドキュメントの更新は、オープンソースプロジェクトや社内チームに適したオリジナルのMarkdownフォーマットを尊重します。

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

1. オープンソースプロジェクトのメンテナンス
   DeepDocsは、ドキュメントを自動的に同期するため、手作業でドキュメントを更新するメンテナーの負担が軽減され、新しい開発者が最新のコードとAPIを迅速に理解できるようになります。
2. 迅速な反復開発チーム
   DeepDocsは、READMEとAPIドキュメントを自動的に更新するため、チームはドキュメントの正確性を保ちながらコーディングに専念できます。
3. 複数倉庫プロジェクト管理
   DeepDocsは、コードとドキュメントが別々に保存されている大規模プロジェクト向けに、リポジトリ間の同期をサポートします。マイクロサービス・アーキテクチャ・チームのために、コード・リポジトリの変更を監視し、ドキュメント・リポジトリのコンテンツを更新します。
4. 技術的負債の整理
   DeepDocsのディープ・スキャン機能により、古いプロジェクトには多くの古いドキュメントが存在することが多いため、これらのドキュメントを一度に修正し、明確な変更レポートを作成することで、チームの技術的負債を迅速に一掃することができます。

品質保証

1. DeepDocs によって、ドキュメントの書式設定やスタイルが変更されますか?
   DeepDocs は、コード変更に関連するドキュメントの部分のみを更新し、元の書式、トーン、および構造を保持します。
2. DeepDocsはどのような種類のドキュメントをサポートしていますか?
   README、APIリファレンス、SDKガイド、チュートリアルなど、ほとんどの技術文書に適したMarkdown形式の文書をサポートします。
3. ディープスキャンを発動させるには？
   修正 deepdocs.yml 正鵠を得る reinit 文字列とコミットによって、DeepDocs はコードベース全体をスキャンし、古いドキュメントを更新します。
4. DeepDocs は私のコードを保存しますか?
   DeepDocsは、実行時にコードを一時的に処理するだけで、処理後にコードを保存しないため、プライバシーとセキュリティが確保されます。
5. DeepDocsでは、最初のドキュメントは必要ですか?
   はい。DeepDocs は、まったく新しいドキュメントを生成しません。DeepDocsは、既存のドキュメントをコードと同期させることに重点を置いています。