すべてのユースケース

繰り返し来るサポート質問を、自動でドキュメント更新に

同じサポート質問が3回出たら、Zero がドキュメント更新をドラフトし、サイトにPRを出します。次の人が聞く前に答えが見つかるように。

Zeroの接続先:SlackGitHubNotion

同じ5つのサポート質問が何度も戻ってくる理由

どのサポートチャンネルにも、死なない5〜6個の質問があります。製品がわかりにくいからではなく、ドキュメントに書かれていないから。それらのスレッドを手動で追い、更新をドラフトし、PRを出す作業は、いつも後回しになる類のもの。ドキュメント自動更新はサポートチャンネルを監視し、繰り返し来る質問をカウントし、異なる3人以上から同じ質問が来た瞬間、ドキュメント更新をドラフトしてPRを出します。レビュアーは2分で承認。同じ質問を持つ次の人は、聞かずに答えを見つけます。

Zero にシグナルからドキュメントを更新させる方法

@Zero 毎週、#support と #community で過去14日間に3人以上から聞かれた質問をスキャン。それぞれについてドキュメント更新をドラフトして、ウェブサイトリポジトリに変更を加えるPRを開いて。

Zero が質問をドキュメントに変える流れ

Zero がサポートチャンネルで繰り返し質問を監視
Zero は入ってくるサポートスレッドを読み、類似質問を意味的にクラスタリングし、ユニークな質問者をカウントします。ローリングウィンドウ内で3人以上から出た質問は、ドキュメントギャップとしてフラグ付けされます。
Zero が解決済みの回答に基づいてドキュメント更新をドラフト
各フラグ付き質問について、Zero はスレッドの解決内容を読み、適切なドキュメント配置先(既存セクションまたは新ガイド)を特定し、具体例とともにサイトのマークダウン形式で更新をドラフトします。
Zero がレビューのためPRを起票
各ドラフトはウェブサイトリポジトリにPRとして届き、トリガーとなった質問スレッドが説明にリンクされます。ドキュメントチームのレビュアーが承認するだけ、ゼロから書く必要はありません。

適切なレビュアーにルーティング、公開、またはカバレッジ拡大

適切なレビュアーにルーティング
PRを汎用レビュアーではなくコンポーネントオーナーに割り当て。
@Zero 課金質問のドキュメントをドラフトするときは、@docs-team ではなく @billing-team をタグ付けして。
低リスクな更新を自動公開
タイポ修正や小さな明確化は人のレビューなしで出荷。
@Zero 50行未満で既存セクションのみを触るドキュメントPRは、CI通過後に auto-merge を有効にして。
カバレッジを拡大
シグナル用に新しいソースチャンネルを追加。
@Zero Slack だけでなく、サポートの Gmail 受信箱でも繰り返し質問をスキャンして。

必要なインテグレーション:Slack と GitHub

Slack
Slack
Slack:Zero は繰り返し質問を検出するためにサポートチャンネルを読み込みます。指定チャンネルへの読み取りアクセスが必要です。
必須
GitHub
GitHub
GitHub:Zero はウェブサイトリポジトリに対してドキュメント更新をPRとしてドラフトします。Zero がブランチを作成しPRを開けるよう、リポジトリへの書き込みアクセスが必要です。
必須
Notion
Notion
Notion:オプション。社内ドキュメントが Notion にあり、Zero にそれも更新させたい場合に便利。
オプション

シグナル駆動のドキュメント更新のベストプラクティス

「繰り返し」のしきい値は1ではなく、14日で3人に設定。1だと毎日ドキュメントを書き直すことになり、3なら本物のギャップを捕捉できます。
ソーススレッドをPR説明に必ず含めること。レビュアーは元の質問を見て、ドラフトが本当に答えているか判断できます。
KBキャプチャと組み合わせて、解決済みスレッドが並行して社内ナレッジベースに流れるように。