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のチャットウィンドウを開く

変更リクエストでは、スペースのヘッダーバーにある 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にページコンテンツを改善するための一般的な操作を実行させるプリセットを選択できます。

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

を開くことで、エディタからアクセスできます。

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

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

いずれかのオプションを選択すると、Agentはすぐにそのタスクに取りかかります。

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

GitBook Agentを使えば、ページ上の任意の空行にコンテンツを作成できます。コードサンプル、テンプレート、ページ要約など、Markdownで整形されたあらゆる種類のコンテンツを作成できます。

押します スペース 任意の空行で、または / と入力して選択 AIで書く を選択してGitBook Agentを起動します。

すぐに好きなプロンプトを入力し始めることができます。GitBook Agentはプロンプトを分析し、それに基づいてコンテンツを生成します。たとえば:

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

または、提案されたプロンプトやプロンプトの書き出しから1つを選ぶこともできます:

書き続ける – GitBook Agentは現在のページのコンテンツを分析し、それに基づいてさらにコンテンツを生成します。
説明する… – これを選択してから、GitBook Agentに何を説明してほしいかを伝えます。これはページ上のコンテンツに制限されないため、何でも説明するよう依頼できます。
要約する – ページ上のすべてのコンテンツを要約します。これは、詳細なドキュメントの末尾にTL;DRを書く場合や、ざっと確認する人向けに先頭に簡単な要約を追加する場合に最適です。
これを説明 – これにより、ページ上の複雑な情報がより簡単な言葉で説明されます。略語やその他の専門用語の説明も含まれます。これは、読んでいるページに複雑な情報が多く含まれている場合や、技術にあまり詳しくない人向けの説明を追加したい場合に最適です。
翻訳 – 現在のページを、用意された複数の言語のいずれかに翻訳します。リストにない言語に翻訳したい場合は、プロンプトボックスにその言語を入力するだけです。

GitBook Agent向けの効果的なプロンプトを書く

GitBook Agentは、指示を受けるのが得意なチームメイトのようなものです。最良の結果を得るには、明確な指示とコンテキストを与える必要があります。

よいプロンプトを書くための簡単なヒントをいくつか紹介します:

分解する – Agentは、焦点を絞ったタスクを完了するのが最も得意です。複雑なプロジェクトはより小さなステップに分解し、Agentに1つずつ完了するよう依頼してください。
具体的にする – 次のような一般的なプロンプト、 @gitbook improve this page は一般的なベストプラクティスを適用しますが、より具体的なガイダンスがなければ、Agentはあなたが思い描いていた目標を達成できない場合があります。
成果に焦点を当てる – 顧客が抱えている特定の問題について聞いているなら、その問題、または達成したい成果をAgentに伝えてください。Agentはそれらの成果に基づいて改善案を提案します。
直接的な指示を出す – ステップバイステップのガイドにステッパーブロックを使ってほしい場合や、展開可能なブロックを多数含むFAQセクションを追加してほしい場合は、最初から正しい結果を得るために、何をすべきかを正確に伝えてください。
より広範な改善には幅広いプロンプトを使う – タイポの修正、ページ間での機能名の更新、ドキュメントから特定のブロックタイプを削除するといったメンテナンスタスクには、次のようなコマンドを使用できます。 @gitbook replace all instances of v2.3.9 with v2.4.0.

最終更新 15 日前

役に立ちましたか？