本指南旨在協助機構組織瞭解說明文件可解決的問題，以及如何為說明文件專案選擇合適的指標。
目前階段：
結果公布時程。
說明你的問題
在選擇指標之前，請先確認您已充分瞭解自己嘗試解決的問題。越明確越好。
- 「合併新手上路文件的提取要求太久才能合併。 貢獻者們放棄。」
- 「我們發現提出太多問題，因此無法解讀錯誤代碼。」
- 「我們的 CI/CD 管道不穩定。太多測試失敗，導致無法理解的原因。」
- 「每週會議中的員工似乎都很惱人。」
制定假設
請尋找原因和影響。是什麼原因造成您遇到的問題？請注意，問題可能有多個或重疊的原因。
- 「合併新手上路文件的提取要求需要很長的時間，因為我們對於樣式沒有明確指引。審查人員因為不知道該怎麼做而放棄評論 PR，，也可能在內容格式方面不斷回訪。」
- 「使用者在說明文件中找不到錯誤代碼的相關資訊，因此必須開啟問題。」
- 「我們對供應商執行的計畫限制和逾時，因此 CI/CD 測試失敗。」
- 「由於會議時間是所在時區上午 5:30，因此大家在每週會議中感到不悅。」
提出解決方案
使用全新或更完善的說明文件，是否可以解決這個問題？
- 「如果我們有風格指南，投資人可在提交 PR 之前先檢查，審查人員會知道要檢查哪些項目。評論者和貢獻者不必只對格式、語氣和風格產生共鳴。」
- 「如果有錯誤代碼的說明文件，使用者就可以在這裡找到答案，不必開啟問題。」
- 「嗯，經過改善的說明文件似乎無法解決我們的 CI/CD 問題。」
- 「每次會議都會用尖叫的笑話開打！我們可以透過這個機會收集大家的笑話來開會，這有助於我們開展笑容。」
取得具體
您能量化問題嗎？
- 「合併 PR 需要很長多久？」還是兩個月？還是兩週？貢獻者在接受審查前要等待多久時間？
- 「發生多少錯誤程式碼相關問題？」「太多問題」？
- 「嗯... 好幾個臭的嗎？」
檢查可評估度
如何查看建議的指標？是否可以輕鬆準確地測量指標？評估作業是否取決於評估的對象？
- 「我們可以輕鬆測量提取要求的開放時間，以及自要求審查後經過的時間。我們無法確實評估貢獻者何時放棄。」
- 「我們可以計算有多少問題標記為「錯誤代碼」，或在問題中搜尋錯誤代碼文字。」
- 「我們無法以實際或準確的方式衡量民眾的粗口。」
新增次要指標
是否有其他指標可協助您瞭解說明文件是否解決了問題？您的目標指標是否都是相同的？
- 「較長的 PR 需要較多時間審查；對於不同規模的 PR，我們應該設有不同的門檻。我們希望測量中小型、中、大型、大型 PR 的合併時間。」
- 「我們可以查看錯誤代碼說明文件收到的次數，看看該數字是否與開啟的問題較少有關。」
選擇時間範圍
- 「我們認為兩個星期是合併中小型 PR 的合理時間，且所有 PR 都應該在一個月內合併。因此我們每週都會進行測量一次。」
- 「我們每天更新錯誤程式碼相關問題的數量並不合理，因為我們一般會在一週後解決問題。我們每週都會評估。」
設定目標
如果希望所選指標成功指出專案成功，您需要觀察到什麼變化？建議您為所選指標設定量化目標。
- 「假設我們不到一個月內就達成所有新的公關活動的目標，就會有很成功。如果讓大型公關作業的平均時間減少了兩週，代表我們非常成功。」
- 「理想上，我們不會再看到新的錯誤相關問題。不過，如果系統發現錯誤相關問題減少 50%，就會認為我們的專案成功。」
相關資訊
- 如需報表相關工作的協助，請參閱機構組織管理員指南。