Mẫu nghiên cứu điển hình về Mùa Tài liệu

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

Sử dụng các tiêu đề mẫu này để tạo báo cáo nghiên cứu điển hình của riêng mình.

Tiêu đề

Tổ chức hoặc dự án: Tên tổ chức (đường liên kết đến trang hoặc trang web Phần Tài liệu của tổ chức)

Mô tả tổ chức: Một bản thuyết trình bán hàng ngắn gọn cung cấp tổng quan ngắn gọn về hoạt động của tổ chức hoặc dự án của bạn.

Tác giả: không bắt buộc: liệt kê tác giả của nghiên cứu điển hình; sử dụng tên người dùng nếu được yêu cầu

Tuyên bố vấn đề

Bạn đang tìm cách giải quyết vấn đề gì bằng tài liệu mới hoặc tài liệu đã cải tiến?

Bản tóm tắt đề xuất

Bản tóm tắt ngắn gọn về đề xuất ban đầu dành cho tổ chức của bạn. Hãy liên kết đến trang đề xuất trên trang web của dự án (nếu có thể).

Nội dung mô tả dự án

Tạo đề xuất

Bạn đưa ra đề xuất về Phần tài liệu như thế nào? Tổ chức của bạn đã sử dụng quy trình nào để quyết định ý tưởng? Bạn thu thập và áp dụng ý kiến phản hồi như thế nào?

Ngân sách

Đưa một mục ngắn vào ngân sách. Bạn ước tính công việc như thế nào? Có chi phí ngoài dự kiến không? Mức chi tiêu của bạn có phải thấp hơn phần thưởng tiền tài trợ không? Bạn còn khoản tiền nào khác ngoài Phần Tài liệu mà bạn có thể sử dụng không?

Người tham gia

Ai đã phụ trách dự án này (sử dụng tên người dùng nếu người tham gia yêu cầu)? Bạn tìm và thuê người viết nội dung kỹ thuật bằng cách nào? Bạn tìm các tình nguyện viên hoặc người tham gia trả phí khác bằng cách nào? Họ có những vai trò gì? Có ai đã bỏ ngang không? Bạn đã tìm hiểu gì về việc tuyển dụng, giao tiếp và quản lý dự án?

Lịch trình

Đưa ra thông tin tổng quan ngắn gọn về tiến trình của dự án (cho biết ngày kết thúc dự kiến hoặc các mốc trung gian nếu dự án đang diễn ra).

Kết quả

Những thông tin nào đã được tạo, cập nhật hoặc thay đổi? Bao gồm các đường liên kết đến tài liệu đã xuất bản (nếu có). Có sản phẩm nào chưa được tạo trong đề xuất không? cũng liệt kê những thành phần đó.

Chỉ số

Bạn chọn chỉ số nào để đo lường mức độ thành công của dự án? Bạn có thể thu thập các chỉ số đó không? Các chỉ số có tương quan tốt hay không tốt với kết quả mà bạn mong muốn đối với dự án? Các chỉ số của bạn có thay đổi kể từ thời điểm bạn đề xuất không?

Phân tích

Bạn đã làm tốt những việc gì? Điều gì bạn không mong muốn? Bạn gặp phải khó khăn hay trở ngại gì? Bạn có cho rằng dự án của mình thành công không? Tại sao hoặc tại sao không? (Nếu còn quá sớm, hãy giải thích thời điểm bạn có thể đánh giá mức độ thành công của dự án.)

Tóm tắt

Trong 2-4 đoạn văn, hãy tóm tắt trải nghiệm của bạn trong dự án. Nêu bật những điều bạn rút ra được và những việc bạn sẽ chọn làm khác đi trong tương lai. Bạn sẽ đưa ra lời khuyên gì cho các dự án khác đang cố gắng giải quyết vấn đề tương tự thông qua tài liệu?

Phụ lục

Nếu có các tài liệu khác mà bạn muốn liên kết (ví dụ: nếu bạn đã tạo hợp đồng làm việc với tác giả kỹ thuật mà bạn muốn chia sẻ, hoặc các mẫu cho dự án tài liệu hoặc các tài liệu mở khác, bạn có thể liệt kê và liên kết chúng ở đây). Phần Phụ lục cũng là nơi phù hợp để liệt kê các đường liên kết đến mọi công cụ hoặc tài nguyên mà bạn đã sử dụng, hoặc là nơi để gửi lời cảm ơn hoặc những lời ghi nhận có thể không phù hợp với các phần trên.