DeepDocs
DeepDocsとは？
DeepDocsは、進化するコードベースと技術ドキュメントの同期プロセスを自動化したい開発チーム向けに設計された、GitHubネイティブのAIエージェントです。コードの変更を自動的にスキャンし、README、APIリファレンス、SDKガイド、チュートリアルなどの関連ドキュメントを更新することで、時代遅れのドキュメントという一般的な問題に対処します。その核となる価値提案は、手作業で時間のかかるドキュメント更新作業をなくし、開発者がコードの出荷に集中できるようにしながら、ドキュメントが正確かつ最新の状態に保たれるようにすることです。GitHubワークフローに直接統合され、インテリジェントでプライバシーを重視した更新を提供します。
DeepDocsの使い方
ユーザーは、GitHub MarketplaceからDeepDocsアプリをリポジトリにインストールすることで利用を開始できます。インストール後、リポジトリのルートにある`deepdocs.yml`ファイルで追跡するドキュメントファイルまたはフォルダを定義して、DeepDocsを設定する必要があります。このYAMLファイルをコミットすると、初期のディープスキャンがトリガーされ、別のブランチで古いドキュメントが更新されます。その後、将来のすべてのコードコミットは、継続的なドキュメント更新を自動的にトリガーします。DeepDocsは、個人またはオープンソースプロジェクト向けにクレジットが制限された無料プランを提供しており、より多くのクレジットと機能を備えた「Pro」プランも近日中に提供予定です。
DeepDocsの主な機能
継続的ドキュメンテーション
ディープスキャン
インテリジェントな更新
詳細なレポート
GitHubネイティブ
プライバシー優先
DeepDocsの使用例
コード変更時にREADMEファイルを自動的に更新する。
APIコードの変更に合わせてAPIリファレンスドキュメントを同期させる。
SDKガイドが最新のライブラリバージョンと機能を反映していることを保証する。
基盤となるコードの進化に合わせてチュートリアルを最新の状態に保つ。
開発チームの手動ドキュメント更新作業をなくす。
単一のスキャンでリポジトリ全体のドキュメントの正確性を保証する。
既存のGitHubワークフローにドキュメント更新をシームレスに統合する。
コードコミットによってトリガーされたドキュメント変更に関する明確なレポートを提供する。
DeepDocsについてのよくある質問
DeepDocsは何をしますか？
DeepDocsは、APIドキュメント、SDKガイド、チュートリアルなどをコードベースと自動的に同期させるGitHubネイティブのAIエージェントです。コードの変更を監視し、古いドキュメントを検出し、詳細なレポートとともに別のブランチで更新を行います。
DeepDocsはドキュメントをゼロから作成しますか？
DeepDocsは既存のドキュメントを維持するために設計されており、ゼロから生成するものではありません。ゼロから始める場合は、GitHub CopilotやCursorなどのAIコードツールが初期バージョンの作成を支援できます。ドキュメントが一度作成されれば、DeepDocsはコードベースと同期させ、コミットごとに自動的に更新します。
リポジトリにDeepDocsを設定するにはどうすればよいですか？
DeepDocsは3つの簡単なステップで設定できます：1. GitHub Marketplaceからアプリをインストールします。2. deepdocs.ymlファイルで追跡したいターゲットドキュメントファイルまたはフォルダを指定します。3. リポジトリのルートにファイルをコミットして、ディープスキャンをトリガーし、破損したドキュメントを更新します。今後のコミットは自動的にドキュメント更新をトリガーします。
DeepDocsは私のドキュメントの構造やスタイルを変更しますか？
いいえ。DeepDocsは、ドキュメントの関連部分のみをインテリジェントに更新します。既存のフォーマットを保持し、ファイルをゼロから書き直すことはありません。
ディープスキャンとドキュメント更新の違いは何ですか？
ディープスキャンは、リポジトリ全体を分析して古いドキュメントを一括で検出し修正するDeepDocsの機能で、手動でトリガーできます。ドキュメント更新は継続的ドキュメンテーション機能であり、コミットごとにトリガーされ、影響を受けるドキュメントのみを識別して更新します。
DeepDocsではクレジットはどのように消費されますか？
DeepDocsは、ディープスキャンに1クレジット、ドキュメント更新プロセスに1クレジットを使用します。
CursorやCopilotのようなAIコーディングエージェントもドキュメントを作成できませんか？
可能です。しかし、手動で何を更新するかを指示した場合に限ります。DeepDocsは異なります。CI/CDが手動デプロイを置き換えたように、DeepDocsは手動のドキュメント更新を置き換え、継続的なドキュメンテーションをワークフローにもたらします。また、コードからドキュメントへの完全なコンテキストで動作するため、プロンプトなしで何が変更され、どのドキュメントが影響を受けるかを認識します。