Tạo nghiên cứu điển hình

Giai đoạn hiện tại:
Chương trình Season of Docs 2021 đã kết thúc vào ngày 14 tháng 12 năm 2021. Xem tiến trình.

Trong Chương trình về tài liệu năm 2021, các tổ chức bắt buộc phải gửi một bản đánh giá và nghiên cứu điển hình cuối cùng. Hãy sử dụng mẫu nghiên cứu điển hình và nghiên cứu điển hình mẫu của chúng tôi làm hướng dẫn để tạo nghiên cứu điển hình cho dự án của riêng bạn.

Biểu mẫu đánh giá cuối cùng sẽ được cung cấp ít nhất một tháng trước ngày 30 tháng 11 năm 2021 lúc 18:00 (giờ UTC).

Tổng quan về nghiên cứu điển hình

Mẫu nghiên cứu điển hình sẽ bao gồm các phần sau:

  • Câu nhận định về vấn đề: bạn đang cố gắng giải quyết vấn đề gì bằng tài liệu mới hoặc tài liệu được cải thiện?
  • Tóm tắt đề xuất: tóm tắt ngắn gọn đề xuất ban đầu của tổ chức
  • Mô tả dự án: nội dung mô tả dự án của bạn. Bao gồm:
    • Cách bạn tạo đề xuất (và đường liên kết đến trang ý tưởng dự án ban đầu).
    • Cách bạn tuyển dụng và chọn một người viết nội dung kỹ thuật hoặc những người tham gia khác.
    • Những người đã làm việc trong dự án (sử dụng tên người dùng nếu người tham gia yêu cầu).
    • Thời gian hoàn thành dự án (nếu đã hoàn thành).
    • Con đã làm tốt những việc gì?
    • Điều gì không mong muốn? Bạn đã gặp phải những trở ngại hoặc khó khăn gì?
    • Tài liệu nào đã được tạo, cập nhật, cải thiện hoặc xoá?
  • Dự án này có dẫn đến bất kỳ quy trình hoặc thủ tục mới hoặc cập nhật nào trong tổ chức của bạn không?
  • Chỉ số:
    • Bạn đã chọn những chỉ số nào để đo lường mức độ thành công của dự án?
    • Bạn có thu thập được những chỉ số đó không?
    • Các chỉ số này có liên quan đến hành vi hoặc điểm chuẩn mà bạn mong đợi không?
    • Các chỉ số bạn đã chọn có thay đổi không? Bạn có xoá hoặc thêm chỉ số nào không?
    • Theo các chỉ số của bạn, dự án của bạn có thành công không? (Có thể còn quá sớm để nói.)
    • Từ giờ trở đi, bạn dự định thu thập chỉ số bao lâu một lần?
  • Tóm tắt:
    • Tóm tắt trải nghiệm của bạn về dự án trong 2-4 đoạn văn. Bạn đã học được gì? Bạn sẽ làm gì khác đi trong tương lai? Bạn sẽ đưa ra lời khuyên gì cho các dự án đang cố gắng giải quyết vấn đề tương tự về tài liệu?

Hướng dẫn về nghiên cứu điển hình

  • Việc ghi nhật ký cập nhật dự án hằng tuần sẽ giúp bạn tạo nghiên cứu điển hình. Đối với mỗi tuần, hãy ghi lại tiến trình dự án (bao gồm cả đường liên kết đến các yêu cầu kéo, vấn đề hoặc cuộc trò chuyện hữu ích), những gì diễn ra suôn sẻ (hoặc không suôn sẻ), những điều bạn đã học được và câu hỏi được đặt ra.
  • Khi viết nghiên cứu điển hình, hãy tử tế. Tránh đổ lỗi và giữ cho cuộc trò chuyện mang tính xây dựng. Hãy nhớ rằng nghiên cứu điển hình là nội dung công khai!
  • Hãy sử dụng cùng một giọng điệu trong nghiên cứu điển hình như bạn làm với bài đăng trên blog hoặc hướng dẫn; đừng quá trang trọng.