このページは Cloud Translation API によって翻訳されました。

プロジェクトに適した指標を選択する

このガイドは、ドキュメントの改善によって解決できる問題の種類と、ドキュメントプロジェクトに適した指標を選択する方法について説明することを目的としています。

現在のフェーズ:
ケーススタディが公開されています。タイムラインをご覧ください。

問題の内容を話します。

指標の選択に進む前に、解決しようとしている問題を十分に把握してください。できるだけ具体的にご記入ください。

原因と結果を探します。お客様からお知らせいただいた問題の原因として、問題には複数の原因や重複する原因が考えられます。

「オンボーディングドキュメントのプルリクエストの統合に時間がかかりすぎます。スタイルに関する明確なガイダンスがないためです。レビュー担当者は、何をすべきかわからないため PR のレビューを先延ばしにするか、フォーマットについてコントリビューターとやり取りします。」
「ドキュメントにエラーコードに関する情報がないため、ユーザーは問題を報告する必要があります。」
「プロバイダのプランの制限とタイムアウトが発生するため、CI/CD テストが失敗します。」
「週次ミーティングが自分のタイムゾーンの午前 5 時 30 分にあるため、参加者が不機嫌です。」

この問題は、新しいまたはより適切なドキュメントで解決できるか

「スタイルガイドがあれば、コミッターは PR を送信する前に確認できます。審査担当者は、何を確認すべきかを知ることができます。審査担当者とコントリビューターは、書式、トーン、スタイルについて議論する必要がなくなります。」
「エラーコードのドキュメントがあれば、ユーザーは問題を報告せずに、ドキュメントで解決策を見つけることができます。」
「うーん、ドキュメントを改善しても CI/CD の問題は解決しなさそうですね。」
「毎回のミーティングをノックノックジョークで始めましょう。ノックノックジョークのコレクションを作成すると、会議を笑顔で始めることができます。」

問題を定量化できますか？

提案された指標はどのように確認しますか？簡単に正確に測定できますか？測定結果は測定者によって異なりますか？

「プルリクエストがオープンされてからどれくらい経過しているか、審査がリクエストされてからどれくらい経過しているかを簡単に測定できます。コントリビューターがいつあきらめたかを正確に測定することはできません。」
「エラーコード」のタグが付けられている問題の数をカウントしたり、問題内でエラーコードのテキストを検索したりできます。」
「ユーザーの不満を慎重かつ正確に測定することはできません。」

ドキュメントが問題を解決しているかどうかを把握するのに役立つ他の指標はありますか？ターゲット指標はすべてのケースで同じですか？

「長い PR は審査に時間がかかります。PR のサイズに応じて異なるしきい値が必要です。小規模、中規模、大規模、巨大な PR の統合時間を測定したいと考えています。」
「エラーコードのドキュメントへのアクセス数を確認し、その数と、オープンされた問題の減少との関連性を確認できます。」

プロジェクトが成功したと判断するには、選択した指標にどの程度の変化が必要でしょうか？選択した指標に定量的な目標を設定する。

「新しい PR を 1 か月以内にすべてクローズするという目標を達成できれば、成功です。大規模な PR のクローズにかかる平均時間が 2 週間短縮されれば、大きな成功です。」
「理想的には、エラーに関連する新しい問題は発生しません。ただし、エラー関連の問題の報告が 50% 減少すれば、プロジェクトは成功と見なされます。」