Docsbookのユースケース:チームがドキュメントを必要とする業務
チームが抱えて訪れる6つの状況と、それぞれにDocsbookがどう対応するかを紹介します。いずれも作業を実行するガイドにつながるため、機能一覧ではなく状況から始められます。
「顧客が尋ねたときに、ChatGPTに当社を推薦してほしい」#
状況。 あなたには製品、顧客、広告予算があります。誰かがAIアシスタントに、あなたの製品と同じことができるツールを尋ねました。しかし、その回答にあなたの会社は含まれていません。
妨げになっていること。 アシスタントは、低コストで読み取って確認できる情報をもとに推薦します。製品が何をするのか、料金はいくらか、どのような制限があるのか、誰が運営しているのか、といった情報です。取得できる場所にそれが書かれていなければ、アシスタントは情報を書いている競合他社を引用します。
Docsbookが行うこと。 DocsbookはページをサーバーでレンダリングされたHTMLとして公開するため、クローラーはJavaScriptを実行しなくてもテキストを認識できます。また、アシスタントが探す情報として、sitemap.xml、canonical URL、JSON-LD、表示される最終更新日、サイトルートのllms.txtを追加します。各ページには独自のURLとタイトルが付くため、1つの狭い質問について書かれたページでも、その質問に関して競争できます。
まずはこちらから: GEO — 生成エンジン最適化、続いてllms.txt。
「ドキュメントにはアクセスがあるが、何か売れているのか分からない」#
状況。 アナリティクスによると、ドキュメントは読まれています。しかし、それを読んだことで誰かが登録したのか、どのページが訪問を無駄にしているのかを説明できる人はいません。
妨げになっていること。 ページビューだけでは、ユーザーの経路は分かりません。イベントと明確な目標がなければ、ドキュメントサイトが報告できるのは人気度であって、進捗ではありません。
Docsbook が行うこと。 Docsbook は、すべてのページでページビュー、検索、読了時間、フィードバック投票、追跡対象のイベントを記録し、それらを経路としてレポートします。誰も到達しないページ、結果が何も返らない検索、読者が離脱するまでにどこまで読んだか、どの国や言語から訪問しているかを把握できます。ページをファネルのステップとしてマークし、何人の読者が最後まで完了したかを数えることもできます。
「ドキュメントが製品より3か月遅れている」#
状況。 製品に変更が加えられました。ドキュメントには依然として古い動作が記載されており、そのことは誰もが知っています。
妨げになっていること。 リポジトリの外部にあるドキュメントでは、別途、更新を思い出して実行する必要があります。執筆と公開の間にビルドとデプロイのステップがあると、5分で済む修正が、誰も始めない作業になってしまいます。
Docsbookが行うこと。 Docsbookは、リポジトリ内にあるMarkdownを提供します。サイトが訪問されるとGitHubを再確認し、変更された内容を再インデックス化するため、プッシュがそのまま公開になります。ビルドステップも、CIパイプラインも、デプロイを待つ必要もありません。編集はウェブエディターから、またはMCP経由のエージェントから行うこともでき、3つの方法すべてで同じリポジトリにコミットとして反映されます。
まずは次から始めましょう: GitHubリポジトリを接続する、次にドキュメントを管理する。
「当社の顧客は英語を読まない」#
状況。 ドキュメントの言語が顧客の検索言語と異なる市場で販売しています。手作業で翻訳すると、英語が変更された瞬間に翻訳が古くなります。
妨げとなるもの。 翻訳は、原文と常に同じレベルに保たれ、独立したページとしてインデックス登録されて初めて公開する価値があります。フォルダーにコピーして貼り付けただけのものでは、どちらも実現できません。
Docsbook が行うこと。 Docsbook はページを15言語(英語、スペイン語、フランス語、ドイツ語、ポルトガル語、イタリア語、ロシア語、中国語、日本語、韓国語、アラビア語、ヒンディー語、トルコ語、ポーランド語、オランダ語)に翻訳します。各言語は適切な hreflang タグを備えた独自のルートで提供されるため、検索エンジンはそれぞれを個別にインデックス登録でき、読者はブラウザーの言語に応じたページにアクセスできます。翻訳はAIによる処理のため、プロジェクト残高を消費します。
まずは次から始めましょう: 翻訳を有効にする、次にAI翻訳。
「サポートは毎週同じ5つの質問に答えている」#
状況。 回答はドキュメントにあります。それでも読者がチケットを起票するのは、該当するページを見つけられなかったからです。
妨げになっていること。 文字どおりのキーワードに一致する検索では、人々が実際にどのように質問するかを捉えられません。見出しとは異なる表現で質問した読者には何も表示されず、代わりに人に尋ねることになります。
Docsbookが行うこと。 DocsbookのAIアシスタントはインデックス化されたページから回答し、回答元のページを示します。そのため、チケットを起票していたはずの読者は、その場で回答を得られます。回答できなかった内容も記録されます。未回答の質問と、結果が何も返されなかった検索が一覧表示されるため、次にどのページを書くべきかが分かります。アシスタントの回答はAIによる処理であり、プロジェクトの残高を消費します。
まずはこちら: AIチャット、次にページフィードバック。
「READMEはあるが、ドキュメントサイトを構築する時間は誰にもない」#
状況。 プロジェクトのドキュメントは長大な README.md と、誰もレンダリングしていない docs/ フォルダーで構成されています。静的サイトジェネレーターのセットアップには1週間かかりますが、そんな時間は確保できません。
妨げとなっているもの。 ジェネレーターは、1ページをレンダリングする前に設定、テーマ、ビルドパイプライン、ホスティング方法の決定を必要とします。その後は、誰かがその4つすべてを保守しなければなりません。
Docsbookが行うこと。 Docsbookはリポジトリをそのまま読み取ります。フォルダー構造はナビゲーションツリーに、見出しはアウトラインになり、相対 .md リンクは実際のURLに解決されます。さらに、全文検索と公開URLを備えたサイトが docsbook.io/{owner}/{repo} で公開されます。記述する設定ファイルはありません。MarkdownがGitHubリポジトリの外に出ることはないため、後から同じリポジトリを別のツールに指定してもコストはかかりません。
まずは: クイックスタート、次に最初のサイトを作成してください。
次のステップ#
- 概要 — Docsbookがリポジトリに対して行うことを最初から最後まで説明します
- 概念 — 上記で使用した用語を、それぞれ一度ずつ定義します
- 料金 — 従量課金の対象と、プロジェクト残高で支払われるものについて説明します
- よくある質問 — キャンセル、プライバシー、同期、データ所有権について説明します