Chọn chỉ số phù hợp cho dự án của bạn

Hướng dẫn này nhằm giúp các tổ chức nắm được những loại vấn đề có thể được giải quyết nhờ những tài liệu hữu ích hơn và cách chọn các chỉ số thích hợp cho dự án tài liệu.

Giai đoạn hiện tại:
Phát triển tài liệu. Xem tiến trình.

Nêu vấn đề của bạn

Trước khi bắt đầu chọn một chỉ số, hãy đảm bảo bạn hiểu rõ về vấn đề mà bạn đang cố gắng giải quyết. Hãy trả lời thật cụ thể.

  • "Việc thu thập yêu cầu tài liệu hướng dẫn làm quen với ứng dụng mất quá nhiều thời gian để hợp nhất. Cộng tác viên từ bỏ."
  • "Chúng tôi nhận thấy có quá nhiều vấn đề đã được mở ra để yêu cầu trợ giúp về việc tìm hiểu mã lỗi."
  • "Quy trình CI/CD của chúng tôi không ổn định. Quá nhiều kiểm thử không thành công vì lý do không dễ hiểu".
  • "Mọi người có vẻ gắt gỏng trong các cuộc họp hằng tuần của chúng tôi."

Xây dựng giả thuyết

Tìm nguyên nhân và kết quả. Đâu có thể là nguyên nhân gây ra vấn đề mà bạn đã nêu? Xin lưu ý rằng sự cố có thể có nhiều nguyên nhân hoặc nguyên nhân trùng lặp.

  • "Việc hợp nhất các yêu cầu lấy dữ liệu đối với tài liệu hướng dẫn làm quen sẽ mất nhiều thời gian vì chúng tôi không có hướng dẫn rõ ràng về kiểu. Người đánh giá hoặc tạm hoãn đánh giá bài PR vì họ không biết nên làm gì hoặc họ qua lại trao đổi với các cộng tác viên về định dạng."
  • "Người dùng phải mở vấn đề vì họ không tìm thấy thông tin về mã lỗi trong tài liệu."
  • "Quá trình kiểm tra CI/CD của chúng tôi không thành công do nhà cung cấp dịch vụ gặp phải những giới hạn và hết thời gian chờ."
  • "Mọi người trở nên khó chịu trong các cuộc họp hằng tuần của chúng tôi vì các cuộc họp diễn ra vào 5:30 sáng theo múi giờ của họ."

Đề xuất một giải pháp

Đây có phải là vấn đề có thể giải quyết bằng tài liệu mới hoặc phù hợp hơn không?

  • "Nếu chúng tôi có hướng dẫn về quy tắc lập trình, người tham dự có thể kiểm tra trước khi gửi PR. Người đánh giá sẽ biết cần kiểm tra những gì. Người đánh giá và cộng tác viên sẽ không cần phải tranh luận về định dạng, giọng điệu và phong cách."
  • "Nếu chúng tôi có tài liệu về mã lỗi, người dùng có thể tìm thấy câu trả lời ở đó, thay vì mở các vấn đề."
  • "Hừm, có vẻ như không có tài liệu nào tốt hơn để giải quyết vấn đề về CI/CD."
  • "Chúng ta có thể bắt đầu mỗi cuộc gặp bằng một câu đùa vui! Việc tạo một tuyển tập truyện cười hài hước sẽ giúp chúng tôi bắt đầu cuộc gặp gỡ với một nụ cười."

Cụ thể

Bạn có thể định lượng vấn đề không?

  • "Việc hợp nhất các kênh quan hệ công chúng có nghĩa là gì? 2 tháng? 2 tuần? Cộng tác viên sẽ đợi xem xét trong bao lâu trước khi từ bỏ?"
  • "Có bao nhiêu vấn đề liên quan đến mã lỗi là "quá nhiều vấn đề"?"
  • "Hmmm ... tại sao lại là người 'quá gắt gỏng'?"

Kiểm tra khả năng đo lường

Bạn sẽ kiểm tra chỉ số mà mình đề xuất như thế nào? Nó có thể được đo lường dễ dàng và chính xác không? Việc đo lường có phụ thuộc vào người thực hiện việc đo lường không?

  • "Chúng tôi có thể dễ dàng đo lường thời gian yêu cầu lấy dữ liệu đã mở và khoảng thời gian kể từ khi yêu cầu xem xét được đưa ra. Chúng tôi thực sự không thể đo lường chính xác khi một cộng tác viên bỏ cuộc."
  • "Chúng tôi có thể đếm số lượng vấn đề được gắn thẻ "mã lỗi" hoặc tìm kiếm văn bản mã lỗi trong các vấn đề."
  • "Chúng tôi thực sự không thể đo lường nếp nhăn của mọi người theo cách khéo léo hoặc chính xác".

Thêm chỉ số phụ

Có chỉ số nào khác có thể giúp bạn hiểu được liệu tài liệu của mình có đang giải quyết vấn đề hay không? Chỉ số mục tiêu của bạn có giống nhau trong mọi trường hợp không?

  • "Các PR dài hơn sẽ mất nhiều thời gian xem xét hơn; chúng tôi cần có các ngưỡng khác nhau cho các quy mô PR khác nhau. Chúng tôi muốn đo lường thời gian hợp nhất cho các PR có quy mô nhỏ, trung bình, lớn và khổng lồ."
  • "Chúng tôi có thể kiểm tra số lượt truy cập mà tài liệu về mã lỗi của chúng tôi nhận được và xem liệu con số đó có tương quan với số lượng vấn đề đã mở ít hơn hay không."

Chọn khoảng thời gian

  • "Chúng tôi cho rằng 2 tuần là thời gian hợp lý để hợp nhất các PR vừa và nhỏ; và tất cả các PR nên được hợp nhất trong vòng một tháng. Vì vậy, chúng tôi sẽ đo lường mỗi hai tuần".
  • "Việc cập nhật số lượng vấn đề liên quan đến mã lỗi hằng ngày là không hợp lý, vì thời gian thông thường để chúng tôi đóng một vấn đề là một tuần. Chúng tôi sẽ đo lường chỉ số này hằng tuần."

Đặt mục tiêu

Bạn cần xem xét mức độ thay đổi như thế nào trong chỉ số đã chọn để xác định rằng dự án đã thành công? Hãy cân nhắc đặt mục tiêu định lượng cho những chỉ số mà bạn chọn.

  • "Nếu chúng tôi đạt được mục tiêu kết thúc mọi PR mới trong vòng chưa đầy một tháng, đó sẽ là một thành công. Nếu thời gian trung bình để chốt các công ty PR lớn của chúng tôi giảm xuống hai tuần, thì đó sẽ là một thành công lớn."
  • "Tốt nhất là chúng tôi sẽ không phát hiện thêm vấn đề mới nào liên quan đến lỗi. Tuy nhiên, chúng tôi sẽ coi dự án của mình thành công nếu nhận thấy số vấn đề liên quan đến lỗi giảm 50%."