GitBook Agentでの執筆
GitBook Agentを使ってページのコンテンツを生成・構築する
GitBook Agentは、GitBookのドキュメント向けコンテンツを生成する強力なツールです。
Agentは、ページの小さなテキストセクションの作成から既存ブロックの編集、新しいページやセクションの作成まで、変更リクエストであらゆる作業を行えます。
GitBook Agentはあなたのスタイルガイドに従います
できます 独自のスタイルガイドやカスタム指示を追加する 組織レベルで—Agentは助けを求めるたびに常にあなたのトーンやスタイルに合わせます。
GitBook Agentは何ができるのか？
GitBook AgentはGitBookアプリに深く統合されているため、エディタで作成できるブロックやスペースの広範なコンテンツを理解します。
つまり、Agentを使って次のことができます：
プロンプトに基づいて新しいコンテンツを作成する
既存ページを検索して特定のコンテンツを更新する
GitBookのさまざまなブロックを最大限に活用するようにコンテンツの再フォーマットを行う
コードサンプルを更新する
ページ間でコンテンツを移動する
特定の位置に新しいページを追加する
GitBook Agentとのやり取り方法
GitBook Agentと作業する方法はいくつかあります：
既存の変更リクエスト内でAgentを開き、必要なことを伝える
GitBook Agentを使って新しい変更リクエストを計画・実行する
ブロックへのコメントでAgentにタグ付けする
ページの空行に新しいコンテンツを作成する
それぞれの方法がどのように動作するかを順に見ていきましょう。
任意の変更リクエストでGitBook Agentのチャットウィンドウを開く
スペースのヘッダーバーにあるボタンを押すと、変更リクエスト内でいつでもAgentのチャットウィンドウを開けます。 GitBook エージェント これにより、アプリの右側にAgentのチャットウィンドウが開きます。
ここでAgentに従わせるプロンプトを書けます—Agentは指示に従いながら何をしているかを説明し、作業に応じてスペースに変更が反映されます。
フォローアップの指示を与えたり手順を明確にしたり、任意の時点でスペースの内容を直接編集したりして、GitBook Agentと並行して作業できます。
GitBook Agentで変更リクエストを実行する
をクリックします GitBook エージェント のセクション 編集 スペースの右上にあるボタンを押してモーダルを開きます。
ここでAgentに変更リクエストに含めたい内容を伝えるプロンプトを書き、変更のコンテキストとして役立つ参照ページを追加できます。
クリックすると 変更リクエストを開始 Agentは変更リクエストを開いて指示の実行を始めます。各段階でAgentはアプリの右側のチャットウィンドウで何をしているかを知らせます。
完了したら、ページ上で直接コンテンツを編集するか、さらに指示を出してAgentに変更を洗練させ続けさせることができます。
コメントでGitBook Agentにタグ付けする
ページの特定のブロックをAgentに見てもらいたい場合は、コメントでタグ付けして必要なことを伝えられます。単にクリックしてください、 ブロックにコメント と入力して@gitbookをタグ付けし、次にやってほしいことを伝えます。
GitBook Agentはプロンプトに基づいてコンテンツを更新し、その後何をしたかをコメントで返信します。
GitBook Agentでページのコンテンツを改善する
この 改善 メニューは、GitBook Agentにページコンテンツを改善する一般的な操作を実行させるプリセットの選択肢を提供します。
エディタから 改善 メニューにはページタイトルにカーソルを合わせるか、ページの…を開くことでアクセスできます。 操作メニュー 
.
改善メニューから、Agentに次のことを指示できます：
ページにアイコンを追加する
コンテンツに基づいてページの説明を生成する
スペルと文法を修正する
他のページと整合性を持たせるために書き直す
SEO向けに最適化する
要約と次のステップのセクションを追加する
関連トピックやページへのリンクを追加する
単一ページを複数ページに分割する
最初の2つのオプションは条件付きです—ページの内容に基づいて変わります。したがって、ページにすでにアイコンと説明がある場合、メニューにそれらの選択肢は表示されません。
任意のオプションを選択すると、Agentが即座にタスクに取りかかります。
空のブロックに新しいコンテンツを作成する
GitBook Agentを使ってページの任意の空行にコンテンツを作成できます。Markdown形式で、コードサンプル、テンプレート、ページ要約など、あらゆる種類のコンテンツを作成できます。
を押す スペース 任意の空行で、またはと入力して / を開き AIで書く GitBook Agentを起動します。
すぐに任意のプロンプトを入力して開始できます。GitBook Agentはプロンプトを分析し、それに基づいてコンテンツを生成します。例：
製品チームにとってドキュメントが重要である理由を二段落で説明する概要を書いてください。
あるいは、提案されたプロンプトやプロンプトスターターのいずれかを選ぶこともできます：
執筆を続ける — GitBook Agentは現在のページの内容を分析し、それに基づいてさらにコンテンツを生成します。
説明… — これを選び、GitBook Agentに説明してほしい内容を伝えてください。これはページの内容に制限されないため、何でも説明を求められます。
要約する — ページ上のすべてのコンテンツを要約します。詳細なドキュメントの下部にTL;DRを書くときや、確認するだけの人のために上部に簡単な要約を追加するときに最適です。
これを説明する — ページ上の複雑な情報をより簡潔な言葉で説明します—略語や専門用語の説明も含みます。ページに複雑な情報が多い場合や、技術的でない人向けの説明を追加したい場合に最適です。
翻訳する — 現在のページを限定された言語群のいずれかに翻訳します。リストにない言語に翻訳したい場合は、プロンプトボックスにその言語を入力してください。
GitBook Agentに効果的なプロンプトを書く
GitBook Agentは指示を受け取るのが得意なチームメイトのようなものです。最高の結果を得るには、明確な指示とコンテキストを与える必要があります。
良いプロンプトを書くための簡単なヒント：
分割する — Agentは焦点を絞ったタスクを完了するのが得意です。複雑なプロジェクトは小さなステップに分解し、Agentに一度に1つずつ完了させてください。
具体的にする — ジェネリックなプロンプトは例えば、
@gitbook このページを改善して一般的なベストプラクティスを適用しますが、より具体的な指示がないとAgentはあなたの意図した目標を達成できない場合があります。成果に焦点を当てる — 顧客が抱える特定の問題について聞いている場合は、その問題や達成したい成果をAgentに伝えてください。Agentはそれらの成果に基づいて改善案を提案します。
直接的な指示を与える — 手順に沿ったガイドにステッパーブロックを使わせたい場合や、展開可能なブロックを複数持つFAQセクションを追加させたい場合は、正確に何をすべきかを指示して最初から正しい結果を得られるようにしてください。
広い改善には広いプロンプトを使う — 誤字修正、機能名のページ全体での更新、ドキュメントから特定のブロックタイプを削除するなどの保守作業には、次のようなコマンドを使用できます：
@gitbook v2.3.9のすべてのインスタンスをv2.4.0に置き換えてください.
最終更新
役に立ちましたか？