Hướng dẫn này nhằm giúp các tổ chức hiểu rõ những loại vấn đề có thể được giải quyết bằng tài liệu tốt hơn và cách chọn các chỉ số phù hợp cho các dự án tài liệu.
Giai đoạn hiện tại:
Nghiên cứu điển hình đã xuất bản. Xem tiến trình.
Nêu vấn đề của bạn
Trước khi chọn một chỉ số, hãy đảm bảo bạn hiểu rõ vấn đề mà bạn đang cố gắng giải quyết. Hãy trả lời thật cụ thể.
- "Các yêu cầu kéo cho tài liệu giới thiệu của chúng tôi mất quá nhiều thời gian để hợp nhất. Người đóng góp sẽ bỏ cuộc và rời đi".
- "Chúng tôi thấy có quá nhiều vấn đề được mở để yêu cầu trợ giúp về mã lỗi".
- "Quy trình CI/CD của chúng tôi không ổn định. Quá nhiều bài kiểm thử không thành công vì lý do không rõ ràng".
- "Mọi người có vẻ khó chịu trong các cuộc họp hằng tuần của chúng tôi".
Phát triển giả thuyết
Tìm mối quan hệ nhân quả. Đâu có thể là nguyên nhân gây ra vấn đề mà bạn nêu? Xin lưu ý rằng các vấn đề có thể có nhiều nguyên nhân hoặc chồng chéo nhau.
- "Việc hợp nhất các yêu cầu kéo cho tài liệu giới thiệu mất rấ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á sẽ hoãn việc xem xét nội dung PR vì họ không biết phải làm gì hoặc họ sẽ trao đổi qua lạ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 thể tìm thấy thông tin về mã lỗi trong tài liệu."
- "Kiểm thử CI/CD của chúng tôi không thành công vì chúng tôi gặp phải các giới hạn về gói và hết thời gian chờ từ nhà cung cấp."
- "Mọi người khó chịu trong các cuộc họp hằng tuần vì cuộc họp diễn ra vào lúc 5:30 sáng theo múi giờ của họ".
Đề xuấ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 tốt hơn không?
- "Nếu chúng ta có một hướng dẫn về quy tắc lập trình, thì người đóng góp có thể kiểm tra hướng dẫn đó trước khi gửi yêu cầu thay đổi. 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 phải tranh cãi 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 tại đó thay vì mở vấn đề".
- "Hmm, có vẻ như việc có tài liệu tốt hơn sẽ không giải quyết được vấn đề CI/CD của chúng ta."
- "Chúng ta có thể bắt đầu mỗi cuộc họp bằng một câu chuyện cười! Việc tạo một bộ sưu tập các câu chuyện cười "đập cửa" sẽ giúp chúng tôi bắt đầu cuộc họp với nụ cười trên môi".
Cho biết thông tin cụ thể
Bạn có thể định lượng vấn đề không?
- "Thông báo "mất quá nhiều thời gian để hợp nhất các bài đăng tin tức" thực sự có nghĩa là gì? Hai tháng? Hai tuần? Những người đóng góp sẽ chờ bao lâu để được xem xét trước khi bỏ cuộc?"
- "Có bao nhiêu vấn đề liên quan đến mã lỗi là "quá nhiều vấn đề"?"
- "Hmmmm … "quá gắt" là như thế nào?"
Kiểm tra khả năng đo lường
Bạn sẽ kiểm tra chỉ số đề xuất của mình như thế nào? Có thể đo lường chỉ số này một cách dễ dàng và chính xác không? Kết quả đo lường có phụ thuộc vào người đo lường không?
- "Chúng ta có thể dễ dàng đo lường thời gian một yêu cầu kéo đã mở và thời gian kể từ khi yêu cầu xem xét. Chúng tôi không thể đo lường chính xác thời điểm một người đóng góp bỏ cuộc".
- "Chúng ta 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 không thể đo lường chính xác hoặc khéo léo mức độ khó chịu của mọi người".
Thêm chỉ số phụ
Có chỉ số nào khác giúp bạn hiểu liệu tài liệu của mình có đang giải quyết vấn đề 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 yêu cầu thay đổi lớn hơn sẽ mất nhiều thời gian hơn để xem xét; chúng ta nên có các ngưỡng khác nhau cho các yêu cầu thay đổi có kích thước khác nhau. Chúng tôi muốn đo lường thời gian hợp nhất cho các yêu cầu thay đổi nhỏ, trung bình, lớn và rất lớn".
- "Chúng ta có thể kiểm tra số lượt truy cập vào tài liệu về mã lỗi và xem liệu con số đó có tương quan với việc ít người mở vấn đề hơn hay không".
Chọn khoảng thời gian
- "Chúng tôi cho rằng hai tuần là khoảng thời gian hợp lý để hợp nhất các yêu cầu thay đổi nhỏ đến trung bình; và tất cả yêu cầu thay đổi phải được hợp nhất trong vòng một tháng. Vì vậy, chúng ta sẽ đo lường 2 tuần một lần".
- "Không cần thiết phải cập nhật số lượng vấn đề liên quan đến mã lỗi hàng ngày, vì thời gian đóng một vấn đề thông thường là một tuần. Chúng tôi sẽ đo lường số liệu này hằng tuần".
Đặt mục tiêu
Bạn cần thấy mức thay đổi bao nhiêu trong chỉ số đã chọn để có thể nói rằng dự án đã thành công? Cân nhắc đặt mục tiêu định lượng cho các chỉ số bạn chọn.
- "Nếu chúng tôi đạt được mục tiêu hoàn tất mọi bài viết quan hệ công chúng mới trong vòng chưa đầy một tháng, thì đó sẽ là một thành công. Nếu thời gian trung bình để đóng các yêu cầu hỗ trợ lớn giảm đi 2 tuần, thì đó sẽ là một thành công lớn".
- "Tốt nhất là chúng ta không thấy vấn đề mới liên quan đến lỗi. Tuy nhiên, chúng tôi sẽ coi dự án của mình là thành công nếu số lượng vấn đề liên quan đến lỗi được mở giảm 50%".
Thông tin liên quan
- Hãy đọc hướng dẫn dành cho quản trị viên tổ chức để được trợ giúp về các nhiệm vụ liên quan đến báo cáo.