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

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

このガイドは、優れたドキュメントによりどのような種類の問題を解決できるか、またドキュメントプロジェクトに適した指標を選択する方法を組織が理解できるようにすることを目的としています。

現在のフェーズ:
結果が発表されましたタイムライン。

問題の内容を伝える

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

原因と結果を探る。お問い合わせいただいた問題の原因として何が考えられますか？問題には複数の、または重複する原因があることに注意してください。

「スタイルについての明確なガイダンスがないため、オンボーディングドキュメントの pull リクエストの統合に非常に時間がかかっています。レビュアーは、やるべきことがわからないという理由で PR のレビューを先送りするか、フォーマットについて投稿者と何度も行き来します。」
「ドキュメントでエラーコードに関する情報を確認できないため、問題を報告する必要があります。」
「プロバイダでプランの制限やタイムアウトが発生したため、CI/CD テストが失敗します。」
「毎週開かれるミーティングは、各自のタイムゾーンの午前 5 時 30 分に始まるため、皆が不満を感じています。」

この問題は、新しいドキュメントやドキュメントで解決できるでしょうか。

「スタイルガイドがあれば、コミッターは PR を送信する前にチェックできます。何を確認すればよいのかがレビュアーにわかっています。レビュー担当者や投稿者が、形式、トーン、スタイルについて議論する必要がなくなります。」
「エラーコードのドキュメントがあれば、ユーザーは問題を開かなくても、そこで答えを見つけることができます。」
「うーん、ドキュメントを改善しても CI/CD の問題を解決できそうにない。」
「どのミーティングもノックノックジョークで始められるわ。ノックノックジョークを集めれば、笑顔でミーティングを始めることができます。」

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

「『PR の統合に時間がかかりすぎる』とはどういう意味でしょうか？2 か月？2 週間？コントリビューターがレビューを諦めるまで、どれくらい待つか」という疑問です。
「エラーコードに関連する問題はいくつありますか」
「うーん...『不機嫌』っていうのは？」

提案された指標をどのように確認しますか？簡単かつ正確に測定できるか誰が測定を行うかによって測定を行うか？

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

「PR が長いほど審査に時間がかかります。PR の規模ごとに異なるしきい値を使用する必要があります。小規模、中規模、大規模、および大規模な PR ごとに統合時間を測定したいと考えています。」
「エラーコードのドキュメントで獲得した訪問数を確認し、その数が未解決の問題の減少と相関しているかどうかを調べることができました。」

「中小規模の PR の統合には 2 週間が適しており、すべての PR は 1 か月以内に統合する必要があると考えています。ですから 2 週おきに測定するわけです
「問題をクローズするまでに通常 1 週間かかるため、エラーコード関連の問題の件数を毎日更新しても意味がありません。週に 1 回、成果を測定しています。」

プロジェクトが成功したと示すためには、選択した指標にどの程度の変化が必要ですか。選択した指標について、定量的な目標を設定することをおすすめします。

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