ドキュメントの自動改善

ドキュメント内の誤っているページや古くなったページを特定し、結果を確認して、GitBook Agentで自動的に修正します

この機能は現在、早期アクセス中です。

アクセスを順次提供しています。以下の機能の進捗については、今後の続報をお待ちください。

GitBook Agent は、コンテンツの不足、古いページ、誤った情報など、ドキュメント内の問題を特定し、改善案を提案して実装できます。

GitBook Agent は何を検出できますか？

• コンテンツの不足 は、GitBook が、ドキュメントでは答えにくい製品に関する質問をユーザーがしていることを検知したときに発生します。たとえば、次のようなケースです:

  • 顧客がサポートチームに質問したが、ドキュメントでは見つけられなかった。
  • 完全なドキュメントが不足している API エンドポイント。
• 古いコンテンツ は、ページ上のコンテンツが外部ソースで見つかったコンテンツによって置き換えられていると検出されたときに発生します。たとえば、次のようなケースです:

  • 関数のシグネチャを変更する SDK の更新。
  • 有料機能が無料プランに移行したにもかかわらず、ドキュメントが更新されていない場合。
• 誤ったコンテンツ は、ドキュメントサイト上のコンテンツが明らかに誤っているときにフラグ付けされます。たとえば、次のようなケースです:

  • もはや存在しない API、または機能が終了した API を指しているガイド。
  • マーケティングサイトなどの外部ソースがドキュメントと食い違っている場合。

検出の仕組み

1

ソースを接続する

GitBook Agent は、サポートのチケットシステム、公開フォーラム、マーケティングサイトなどの外部ソースと接続されているときに最適に機能します。一部のソースでは、セットアップ完了前に追加の API キーまたは認証が必要です。 接続について詳しく見る。

2

GitBook Agent が結果を生成

GitBook は定期的にソースを確認し、その結果に基づいて検出結果を生成します。GitBook はこれらの検出結果をチームが確認できるように収集します。 データの取り込み方法について詳しく見る。

3

検出結果を確認する

問題の修正を開始するには、検出結果を確認してください。各検出結果には、問題の概要、該当トピック、裏付けとなる証拠、そして GitBook がコンテキストとして使用したページへのリンクが含まれます。

4

修正またはアーカイブ

一部の検出結果は、GitBook Agent によって自動的に修正できます。そのオプションが利用できる場合は、 変更リクエスト を検出結果から直接作成できます。アクティブ一覧に残したくない検出結果は、アーカイブすることもできます。

GitBook Agent の自動ドキュメント改善機能へのアクセスをリクエストするには、サイトの 設定.

自動修正

検出結果が自動修正をサポートしている場合、GitBook は 変更リクエストを作成 アクションを表示し、GitBook Agent がチーム確認用の修正案を生成できるようにします。提案をスキップするには、代わりに検出結果をアーカイブしてください。GitBook は、アーカイブした検出結果を再度開くことはありません。