GitBook Agentとは?
AIのチームメイトと協力して、ドキュメントを正確、完全、最新の状態に保つ
GitBook Agentは、あなたとともに働き、ドキュメントを正確で完全かつ最新の状態に保つ手助けをするAIのチームメイトです。
AgentはGitBookと深く統合されているため、それを利用するために新しいワークフローを学ぶ必要はありません — 既に知っているプロセスに沿ってあなたと一緒に働きます。
GitBook Agentは何ができるのですか?
GitBook Agentは次のことができます:
プロンプトに基づいてドキュメントを書く: Agentにページを最新の情報で更新するよう依頼したり、製品名の記載をすべて新しい名前に置き換えたり、必要なあらゆることを頼めます。
大きな変更を構想して実装する: 必要な内容を説明すると、Agentは変更リクエストを作成し、計画した編集内容を説明し、フィードバックに応答し、その後あなたと一緒に作成した計画を実行します。
スタイルガイドを理解する: 組織の設定にスタイルガイドを追加すると、コンテンツの作成やレビュー時に常にそれが適用されます。
組織レベルのカスタム指示に従う: リンクを特定の方法で追加する、特定のブロックタイプを避けるなど、組織レベルでAgentに特定の指示を与えることができます。
ドキュメントを翻訳する: 翻訳したいコンテンツを選択し、言語を選べば、Agentがドキュメントのローカライズ作業を行います。
コメントから呼び出す: ページ上の任意のブロックにコメントを追加し、@gitbookと入力してAgentに必要なことを伝えます。
変更リクエストをレビューする: 変更リクエストにAgentをレビュアーとして追加できます。Agentはドキュメントのリンターとして機能し、エラーを特定または修正し、改善を提案し、スタイルガイドの逸脱を指摘できます。
自動ドキュメント提案
Agentは、サポート会話、チケット、接続されたツールからのスレッドなど、チームが製品やユーザーのニーズを理解するために使用する同じシグナルにも接続できます。
このコンテキストをもとに、Agentは積極的にギャップを特定し、更新を提案し、ドキュメントの変更を自動的に生成できます。これにより、ドキュメントは製品とともに進化し、ユーザーは必要な時と場所で常に適切な情報を得られます。
GitBook Agentの機能を探索する
スタイルガイドとカスタム指示を追加する
チームのスタイルガイドやチームとどのように連携してほしいかの具体的な指示を追加することで、GitBook Agentを構成できます。Agentは組織内でコンテンツを作成または編集する際に、これらをコンテキストとして使用します。
スタイルガイドやカスタム指示を追加するには、あなたの 組織設定を 開き、次に GitBook Agent セクションを選びます。 設定 タブをクリックし、テキスト入力欄に指示を追加してください。
この画面には、変更リクエスト内でGitBook Agentのチャットウィンドウを開き、次に アクションメニューを 開いて GitBook Agentを構成する
.
カスタム指示の例
以下は、GitBook Agentの設定に追加できるカスタム指示の例です。
あなたはStripeのテクニカルライターです。明確で直接的な言葉を使い、装飾よりも正確さを重視してください。ガイドでは、常に概念を一文で要約して紹介し、コンテンツをよく構成されたセクションに分けてください。クイックスタートでは、常にステッパーを使用し、各ステップを行動優先で簡潔にしてください。よくある質問
最終更新
役に立ちましたか?