為專案選擇適當的指標

本指南旨在協助機構瞭解，可以透過更妥善的說明文件解決哪些問題，以及如何為說明文件專案選擇適當的指標。

當前階段：
說明文件開發。請參閱時間表。

說明問題

在開始選擇指標之前，請務必先充分瞭解要解決的問題。越明確越好。

  • 「這份新手上路說明文件的提取要求合併時間過長。 貢獻者放棄並徹底放棄。」
  • 「我們發現您開啟的問題過多，因此無法解析錯誤代碼。」
  • 「我們的 CI/CD 管道發生問題。太多測試因難以理解的原因而失敗。」
  • 「在我們的每週會議中，大家似乎都很暴動。」

提出假設

找出因果關係和影響。說明問題的可能原因為何？請注意，問題可能有多種或重疊的原因。

  • 「由於我們沒有清楚的樣式指引，因此合併上線說明文件的提取要求需要很長的時間。審查人員可能會因不知道該做什麼事，所以不曾評論 PR 評論，或者在重新向貢獻者徵詢格式意見。」
  • 「使用者在說明文件中找不到錯誤代碼的相關資訊，因此必須解決問題。」
  • 「我們的 CI/CD 測試失敗，因為供應商遇到供應商提供的方案限制和逾時情況。」
  • 「大家都對每週會議感到不舒服，因為會議是在他們所在時區的清晨 5:30 開會。」

提出解決方案

使用新的或更好的說明文件就能解決這個問題嗎？

  • 「如果有風格指南，修訂人員可以在提交 PR 前先進行檢查。審查人員會知道要檢查哪些項目。審查者和貢獻者不必煩惱格式、調性和風格方面的問題。」
  • 「如果我們有錯誤代碼的說明文件，可以讓使用者不必開啟問題，就可以找到答案。」
  • 「嗯，說明文件似乎不適合解決我們的 CI/CD 問題。」
  • 「我們可以每次開會時，都出現幾個驚呼的笑話！建立一系列催眠的笑話，有助於我們開會來場微笑。」

取得具體值

你能將問題量化嗎？

  • 「『合併 PR 需要太久的時間』是什麼意思？兩個月？兩週？貢獻者需要多久時間才能決定是否放棄？
  • 「有多少問題與錯誤程式碼有關？」
  • 「嗯...脾氣暴躁」嗎？

檢查可評估度

如何查看建議的指標？它能否輕鬆準確地進行測量？評估方式是否取決於進行評估的人員？

  • 「我們能輕鬆評估提取要求開放多久時間，以及提出審查要求至今的時間。因此我們無法確實衡量貢獻者何時放棄」
  • 「我們可以計算標記為「error-code」的問題數量，或在問題內搜尋錯誤代碼文字。」
  • 「我們不能以緊實或準確的方式衡量民眾的暴躁。」

新增次要指標

還有其他指標可協助您瞭解說明文件是否解決了問題？您的目標指標在各種情況下是否都相同？

  • 「較長的 PR 需要較長的審核時間；我們對於不同 PR 大小來說，應該有不同的閾值。我們想要測量小、中、大和大型 PR 的合併時間。」
  • 「我們可以查看錯誤代碼說明文件收到的造訪次數，看看這個數字是否與開啟的問題較少相關。」

選擇時間範圍

  • 「我們認為在兩週後是合併中小型 PR 的合理時間，且所有 PR 應在一個月內合併。我們每兩週評估一次」
  • 「我們一般只會在一週時間內關閉錯誤碼相關問題，所以每天更新錯誤程式碼相關問題的數量並不合理。我們將每週測量一次。」

設定目標

為了表示專案成功，您必須在所選指標中看到多少變化？考慮為所選指標設定量化目標。

  • 「如果我們達成在不到一個月內關閉每個新的 PR 的目標，您的做法是成功。如果我們的平均 PR 結案時間減少了兩週，就表示成績非常成功。」
  • 「理想情況下，我們不會再看到任何新的錯誤相關問題。但如果錯誤相關問題開來了 50%，我們就會認為專案成功。」