GitBook Agentで執筆する

GitBook Agentを使って、ページ用のコンテンツを生成・作成します

GitBook Agentは、GitBookでドキュメント用のコンテンツを生成するための強力なツールです。

Agentは、ページに短い文章を書くことから、既存ブロックの編集、新しいページの作成など、変更リクエスト内でさまざまなことを行えます。

GitBook Agentはスタイルガイドに従います

チームの執筆ルールをスタイルガイドで定義すると、Agentに支援を依頼するたびに、それを信頼できる唯一の情報源として扱います。Agentはスタイルガイドの 最初のページ をすべてのタスクでコンテキストに読み込むため、主要なルールはそこに記載してください。

また、簡単なカスタム指示を追加することもできます。

GitBook Agentでできること

GitBook AgentはGitBookアプリに深く統合されているため、エディタで作成できるブロックや、セクション内のより広範なコンテンツを理解します。

つまり、Agentを使用して次のことができます。

プロンプトに基づいて新しいコンテンツを作成する
既存のページを検索し、特定のコンテンツを更新する
GitBookのさまざまなブロックを最大限に活用できるようにコンテンツを再フォーマットする
コードサンプルを更新する
ページ間でコンテンツを移動する
特定の場所に新しいページを追加する

GitBook Agentとのやり取り方法

GitBook Agentを使用する方法はいくつかあります。

既存の変更リクエスト内でAgentを開き、必要なことを伝える
GitBook Agentで新しい変更リクエストを計画して実装する
ブロック上のコメントでAgentをタグ付けする
ページ上の空行に新しいコンテンツを作成する

それぞれの仕組みを見ていきましょう。

任意の変更リクエストでGitBook Agentのチャットウィンドウを開く

変更リクエストでは、セクションのヘッダーバーにある GitBook Agent ボタンをクリックすると、いつでもAgentのチャットウィンドウを開けます。アプリの右側にAgentのチャットウィンドウが表示されます。

ここでは、Agentに従わせるプロンプトを記述できます。Agentは指示に従う際に何をしているかを説明し、作業の進行に伴って変更がセクションに表示されます。

フォローアップの指示を出したり、手順を明確にしたり、いつでもセクションのコンテンツを直接編集したりできるため、GitBook Agentと共同で作業できます。

GitBook Agentで変更リクエストを実装する

次の GitBook Agent 部分をクリックします編集セクション右上のボタンの一部をクリックして、モーダルを開きます。

ここでは、変更リクエストに含めたい内容をAgentに伝えるプロンプトを記述し、変更のコンテキストとして役立つ可能性がある参照ページを追加できます。

次のボタンをクリックすると 変更リクエストを開始 Agentが変更リクエストを開き、指示の実行を開始します。各段階で、Agentはアプリ右側のチャットウィンドウで実行内容を伝えます。

完了したら、ページ上でコンテンツを直接編集することも、変更をさらに調整するようAgentに追加の指示を出すこともできます。

コメントでGitBook Agentをタグ付けする

ページ上の特定のブロックをAgentにレビューしてほしい場合は、コメント内でタグ付けして必要なことを伝えます。 ブロックにコメント をクリックし、@gitbookをタグ付けしてAgentを指定してから、実行してほしい内容を伝えます。

GitBook Agentはプロンプトに基づいてコンテンツを更新し、実行した内容をコメントへの返信で知らせます。

GitBook Agentでページのコンテンツを改善する

「改善」メニューでは、ページコンテンツを改善するための一般的なアクションをGitBook Agentに実行させるプリセットを選択できます。

エディタでは、改善ページタイトルにカーソルを合わせるか、ページの アクションメニュー .

を開くと、「改善」メニューにアクセスできます。「改善」メニューから、Agentに次のことを指示できます。

ページのアイコンを追加する
コンテンツに基づいてページ説明を生成する
スペルと文法を修正する
ほかのページとの一貫性を保つように書き直す
SEO向けに最適化する
要約と次のステップのセクションを追加する
関連するトピックやページへのリンクを追加する
1つのページを複数のページに分割する

最初の2つのオプションは条件付きであり、ページのコンテンツに応じて変わります。そのため、ページにすでにアイコンと説明がある場合、それらの選択肢はメニューに表示されません。

任意のオプションをクリックすると、Agentはすぐにタスクに取りかかります。

空のブロックに新しいコンテンツを作成する

GitBook Agentを使用すると、ページ上の任意の空行にコンテンツを作成できます。コードサンプル、テンプレート、ページの要約など、Markdownでフォーマットされたさまざまなコンテンツを作成できます。

空行で Space キーを押すか、次を入力します / してから、 AIで作成 を選択すると、GitBook Agentを起動できます。

任意のプロンプトをすぐに入力できます。GitBook Agentはプロンプトを分析し、それに基づいてコンテンツを生成します。例：

プロダクトチームにとってドキュメントが重要である理由を説明する、2段落の概要を書いてください。

または、提案されたプロンプトやプロンプトの書き出しから選択できます。

執筆を続ける — 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 に置き換えて.

最終更新 17 日前

役に立ちましたか？