프로젝트에 적합한 측정항목 선택

이 가이드는 조직에서 더 나은 문서화로 해결할 수 있는 문제 유형과 문서 프로젝트에 적절한 측정항목을 선택하는 방법을 이해하는 데 도움이 됩니다.

현재 단계:
우수사례가 게시되었습니다. 타임라인을 참고하세요.

문제를 설명합니다.

측정항목을 선택하기 전에 해결하려는 문제를 잘 이해해야 합니다. 최대한 구체적으로 답해 주세요.

  • '온보딩 문서의 풀 리퀘스트를 병합하는 데 시간이 너무 오래 걸립니다. 참여자가 포기하고 떠납니다."
  • '오류 코드 이해를 위해 문의하는 문제가 너무 많습니다.'
  • "CI/CD 파이프라인이 불안정합니다. 이해하기 어려운 이유로 너무 많은 테스트가 실패합니다.'
  • "주간 회의에서 사람들이 불만족스러워하는 것 같습니다."

가설 수립

원인과 결과를 찾습니다. 말씀하신 문제의 원인은 무엇인가요? 문제의 원인은 여러 개이거나 중복될 수 있습니다.

  • "스타일에 관한 명확한 안내가 없어 온보딩 문서에 대한 풀 리퀘스트를 병합하는 데 시간이 너무 오래 걸립니다. 검토자는 무엇을 해야 할지 몰라서 PR 검토를 미루거나 참여자와 형식 지정에 관해 주고받습니다."
  • "사용자가 문서에서 오류 코드에 관한 정보를 찾을 수 없어 문제를 열어야 합니다."
  • '제공업체의 계획 제한 및 제한 시간으로 인해 CI/CD 테스트가 실패합니다.'
  • "주간 회의가 해당 시간대의 오전 5시 30분에 열리기 때문에 사람들이 회의에 불만족합니다."

해결 방법 제안

새로운 또는 더 나은 문서로 해결할 수 있는 문제인가요?

  • "스타일 가이드가 있으면 커밋터가 PR을 제출하기 전에 확인할 수 있습니다. 검토자가 무엇을 확인해야 하는지 알 수 있습니다. 검토자와 참여자가 서식, 어조, 스타일에 관해 논쟁할 필요가 없습니다."
  • "오류 코드 문서가 있으면 사용자가 문제를 열지 않고도 문서에서 답변을 찾을 수 있습니다."
  • "문서를 개선해도 CI/CD 문제가 해결되지 않을 것 같습니다."
  • "회의마다 넌센스 퀴즈로 시작할 수 있습니다. 웃음을 띤 얼굴로 회의를 시작할 수 있도록 Knock Knock 농담 모음을 만들어 보세요."

구체적으로 설명하기

문제를 정량화할 수 있나요?

  • "PR 병합하는 데 시간이 너무 오래 걸린다'는 게 무슨 뜻인가요? 2개월? 2주? 참여자가 검토를 기다리다가 포기하기까지 얼마나 걸리나요?"
  • '오류 코드 관련 문제가 '너무 많음'인 경우는 몇 개인가요?'
  • "음… '너무 짜증이 난 상태'는 어느 정도인가요?"

측정가능성 확인

제안된 측정항목을 확인하려면 어떻게 해야 하나요? 쉽고 정확하게 측정할 수 있나요? 측정값은 측정하는 사람에 따라 달라지나요?

  • "풀 리퀘스트가 열려 있는 시간과 검토가 요청된 후 경과한 시간을 쉽게 측정할 수 있습니다. 참여자가 포기하는 시점을 정확하게 측정할 수는 없습니다."
  • "'error-code' 태그가 지정된 문제의 수를 집계하거나 문제 내에서 오류 코드 텍스트를 검색할 수 있습니다."
  • "사람들의 불만족도를 재치 있고 정확한 방식으로 측정할 수는 없습니다."

보조 측정항목 추가

문서가 문제를 해결하고 있는지 파악하는 데 도움이 되는 다른 측정항목이 있나요? 타겟 측정항목이 모든 경우에 동일한가요?

  • 'PR이 길면 검토하는 데 시간이 더 오래 걸립니다. PR 크기에 따라 다른 기준을 적용해야 합니다. 소규모, 중규모, 대규모, 초대규모 PR의 병합 시간을 측정하려 합니다."
  • "오류 코드 문서에 발생하는 방문 수를 확인하고 이 숫자가 더 적은 수의 문제가 열리는 것과 관련이 있는지 확인할 수 있습니다."

기간 선택

  • '소규모~중규모 PR을 병합하는 데는 2주 정도가 적당하며 모든 PR은 한 달 이내에 병합되어야 합니다. 따라서 2주마다 측정합니다."
  • "문제를 종료하는 데 보통 일주일이 걸리므로 오류 코드 관련 문제 수를 매일 업데이트하는 것은 적절하지 않습니다. 매주 측정할 예정입니다.'

목표 설정

프로젝트가 성공했다고 말하려면 선택한 측정항목에서 어느 정도의 변화가 있어야 하나요? 선택한 측정항목에 대한 정량적 목표를 설정해 보세요.

  • "한 달 이내에 모든 신규 PR을 종료한다는 목표를 달성하면 성공입니다. 대규모 PR을 종료하는 데 걸리는 평균 시간이 2주 줄어든다면 큰 성공이라고 할 수 있습니다."
  • "가장 좋은 상황은 새로운 오류 관련 문제가 발생하지 않는 것입니다. 하지만 오류 관련 문제의 신고 건수가 50% 감소하면 프로젝트가 성공했다고 간주할 수 있습니다."