이 페이지는 Cloud Translation API를 통해 번역되었습니다.

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

이 가이드는 조직이 더 나은 문서화로 해결할 수 있는 문제의 종류와 문서 프로젝트에 적절한 측정항목을 선택하는 방법을 이해하는 데 도움을 주기 위해 작성되었습니다.

현재 단계:
결과 발표 일정

문제 설명

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

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

“스타일에 대한 명확한 지침이 없기 때문에 온보딩 문서에 대한 pull 요청을 병합하는 데 시간이 너무 오래 걸립니다. 검토자가 무엇을 해야 할지 모르기 때문에 PR 검토를 미루거나 형식 지정에 관한 참여자와 연락을 주고받곤 합니다."
"사용자가 문서에서 오류 코드에 대한 정보를 찾을 수 없으므로 문제를 해결해야 합니다."
“제공업체의 계획 한도 및 시간 초과로 인해 CI/CD 테스트가 실패합니다.”
"회의가 각자의 시간대에서 오전 5시 30분에 진행되기 때문에 사람들이 주간 회의에 불평합니다."

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

"스타일 가이드가 있으면 커밋한 사용자가 PR을 제출하기 전에 스타일 가이드를 확인할 수 있습니다. 검토자는 무엇을 확인해야 하는지 알 것입니다. 검토자와 기여자가 형식, 어조, 스타일에 대해 논쟁을 벌일 필요가 없습니다.”
"오류 코드 문서가 있으면 사용자가 문제를 여는 대신 그곳에서 답을 찾을 수 있습니다."
“음, 더 나은 문서화로 CI/CD 문제를 해결할 수 있는 것 같지 않습니다.”
"각 회의를 똑똑한 농담으로 시작할 수 있었어요. 유머를 모아 웃으면서 회의를 시작할 수 있다면 큰 도움이 될 것입니다."

문제를 수치화할 수 있나요?

“'PR을 병합하는 데 너무 오래 걸립니다'가 의미하는 바는 무엇인가요? 두 달? 2주? 참여자가 검토를 포기하기까지 얼마나 기다려야 하나요?”
"얼마나 많은 오류 코드 관련 문제가 '너무 많은 문제'인가요?"
"음... 얼마나 심술궂은지?"

제안된 측정항목을 어떻게 확인할 수 있을까요? 쉽고 정확하게 측정할 수 있나요? 누가 측정을 수행하는지에 따라 측정값이 달라지나요?

"pull 요청이 열린 시간과 검토가 요청된 후 경과된 시간을 쉽게 측정할 수 있습니다. 기여자가 언제 포기하는지 정확히 측정할 수는 없습니다.”
"'error-code'로 태그가 지정된 문제 수를 세거나 문제 내에서 오류 코드 텍스트를 검색할 수 있습니다."
"사람들의 불만스러움을 재치 있게 또는 정확하게 측정할 수는 없습니다."

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

"PR이 길수록 검토하는 데 더 많은 시간이 걸립니다. PR 크기마다 다른 기준이 있어야 합니다. 중소, 대형 및 대규모 PR의 병합 시간을 측정하려고 합니다."
“오류 코드 문서에서 방문수를 확인하고 그 수가 미해결된 문제 감소와 관련이 있는지 확인할 수 있었습니다.”

“중소 규모의 PR을 병합하는 데는 2주가 적절하다고 생각하며 모든 PR을 한 달 내에 병합해야 합니다. 2주마다 측정하겠습니다.”
“오류 코드 관련 문제의 수를 매일 업데이트하는 것은 말이 되지 않습니다. 문제를 해결하는 데 일반적으로 1주일이 소요되기 때문입니다. 매주 측정하겠습니다.”

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

"새로운 PR을 한 달 이내에 모두 종료한다는 목표를 달성했다면 성공할 것입니다. 대규모 PR을 마감하는 데 걸리는 평균 시간이 2주 단축되면 큰 성공이 될 것입니다."
“이상적으로는 새로운 오류 관련 문제가 발생하지 않습니다. 하지만 오류 관련 문제가 50% 감소한 경우에는 프로젝트가 성공한 것으로 간주할 것입니다."