DeepDocsを使用する際には、いくつかの注意点があります:
- 初回必要書類DeepDocsは新しいドキュメントを生成しないため、プロジェクトにベースとなるドキュメントがすでに存在する必要があります(GitHub Copilotなどのツールで作成できます)。
- 倉庫間コンフィギュレーションドキュメントとコードが異なるリポジトリにある場合は、両方のリポジトリに DeepDocs をインストールする必要がありますが、deepdocs.yml はコード・リポジトリにのみ構成します。
- フォーマットの保持DeepDocsは、書式のリファクタリングよりもコンテンツの更新に重点を置いているため、元のドキュメントが適切に構造化され、書式化されていることを保証します。
- レビュー・メカニズムDeepDocsは自動的に更新できますが、チームは常にDeepDocsをレビューし、GitHubのプル・リクエストの仕組みを通じて変更を確認することをお勧めします。
- マークダウンのサポート現在のところ、ドキュメントは主にMarkdown形式でサポートされていますが、その他の形式では追加処理が必要です。
DeepDocsは、最小限の構成と最大限の自動化を目的として設計されていますが、事前に適切な計画を立てることで、最高のエクスペリエンスを実現できます。チームには、自動化レベルと制御精度のバランスを取りながら、ニーズに合わせて構成を調整する柔軟性があります。
この答えは記事から得たものである。DeepDocs:コードドキュメントを自動更新するGitHubのAIツールについて