Giai đoạn hiện tại:
Phát triển tài liệu. Xem tiến trình.
Mùa Tài liệu là một chương trình phát triển bền vững do Văn phòng Chương trình nguồn mở của Google quản lý. Mục tiêu của Phần tài liệu là:
- Hỗ trợ các dự án nguồn mở để giải quyết vấn đề của dự án thông qua tài liệu
- Tạo cơ hội cho người viết nội dung kỹ thuật học hỏi kinh nghiệm trong lĩnh vực nguồn mở
- Nâng cao nhận thức về nguồn mở, tài liệu và văn bản kỹ thuật
- Thu thập và chia sẻ thông tin về các chỉ số hiệu quả trong tài liệu nguồn mở
Thông tin thêm về Phần Tài liệu có trên trang web của chương trình.
Tổng quan về chương trình năm 2022
Cách phần Tài liệu hoạt động
Trong phần Tài liệu, các tổ chức sẽ đăng ký bằng cách gửi đề xuất dự án. Đề xuất dự án bao gồm:
- Thông tin về tổ chức
- Nội dung mô tả vấn đề mà dự án đang gặp phải
- Cách dự án sử dụng tài liệu để giải quyết vấn đề
- Cách dự án đo lường mức độ hiệu quả của tài liệu (chỉ số)
- Tiến trình công việc
- Ngân sách dự án
- Mọi thông tin bổ sung, chẳng hạn như kinh nghiệm của tổ chức về các chương trình tương tự hoặc bất kỳ thông tin nào khác có thể giúp quản trị viên Mùa Tài liệu hiểu rõ dự án và vấn đề của họ
Sau khi được chấp nhận tham gia chương trình, các tổ chức sẽ trực tiếp tuyển dụng và thuê biên kịch kỹ thuật của riêng mình. Season of Tài liệu sử dụng Open Collective để tài trợ cho các tổ chức, còn các tổ chức thanh toán cho người viết nội dung kỹ thuật thông qua Open Collective. Ngân sách dự án và các khoản thanh toán đều minh bạch; ngân sách được đưa vào đề xuất dự án của tổ chức có trên trang web Phần tài liệu và các khoản thanh toán hiển thị trong tài khoản Open Collective của Phần Tài liệu.
Các tổ chức được coi là đã hoàn thành chương trình khi gửi báo cáo nghiên cứu điển hình. Các tổ chức cũng được yêu cầu hoàn tất hoạt động đánh giá hằng tháng trong chương trình và khảo sát 3 quý theo quý trong năm sau khi hoàn thành chương trình.
Tiêu điểm năm 2022
“Sau khi tài liệu mới được phát hành, số lượt truy cập hằng ngày vào Casbin và Casdoor đã tăng gần gấp đôi, còn tỷ lệ thoát giảm khoảng 30%.” – Casbin
"Một kết quả đáng mong chờ của dự án này là chứng kiến [người viết nội dung kỹ thuật của chúng tôi] trở thành lãnh đạo trong cộng đồng. Hiện tại, cả hai cộng tác viên đều đang dẫn dắt các cuộc họp nhóm làm việc và cộng đồng, cũng như đóng góp vào việc thiết kế và duy trì các dự án của chúng tôi.” —moja-global
"[GSoD] đã giúp chúng tôi chiêu mộ được hai nhà văn kỹ thuật tài năng, vốn là những người rất khó khăn trong công tác thiết lập. Họ vẫn tiếp tục đóng góp tích cực cho hệ điều hành của OpenMined và những người mà chúng tôi đã có kinh nghiệm làm việc tuyệt vời." — OpenMined
“Ngoài ra, hướng dẫn mới cũng dễ dàng hơn cho những người mới tham gia đo phổ khối lượng tính toán. Để minh hoạ cho điều này: khoản trợ cấp của CZI cũng cấp tiền thù lao cho những cá nhân trong quá khứ và một số người được trao thưởng đã sử dụng tài liệu hướng dẫn mới của OpenMS để bắt đầu giai đoạn thực tập 6 tuần và đưa ra những đánh giá tích cực về cuốn hướng dẫn mới này.” –OpenMS
Dữ liệu tóm tắt năm 2022
Năm 2022, chương trình Mùa Tài liệu đã chấp nhận 31 dự án từ 67 đơn đăng ký và 30 dự án đã hoàn thành chương trình. Trong số 31 tổ chức được chấp nhận, 17 tổ chức là người đăng ký nhiều lần.
31 dự án được chấp nhận đã tuyển dụng 58 nhà biên kịch kỹ thuật. Hơn 190 người viết nội dung kỹ thuật đã thể hiện mong muốn tham gia chương trình này bằng cách thêm thông tin liên hệ và đường liên kết vào danh mục của họ trong kho lưu trữ Mùa tài liệu GitHub.
Đối với chương trình năm 2022:
- 100% tổ chức có trải nghiệm tích cực với quy trình đăng ký
- 100% tổ chức có trải nghiệm tích cực với tài liệu/nội dung trên trang web của chương trình
- 93% tổ chức có trải nghiệm tích cực với chương trình
- 90% tổ chức cảm thấy dự án lập tài liệu của họ đã thành công
Giới thiệu về tổ chức
Các tổ chức tham gia Mùa Tài liệu 2022 đại diện cho nhiều dự án nguồn mở. Nhóm thuần tập năm 2022 bao gồm:
- Các công cụ phát triển, chẳng hạn như AsyncAPI và SpyderIDE
- Ngôn ngữ và khung lập trình, chẳng hạn như Julia, LFortran, R và p5.js
- Các dự án khoa học như CERN-HSF và SymPy
- Các ứng dụng dành cho người dùng cuối, chẳng hạn như Mautic, Open Food Facts, Talawa và Ushahidi
- Các dự án phần cứng và robot, chẳng hạn như ExpressLRS và Open-RMF
- Các dự án dữ liệu, chẳng hạn như GeomScale, GeomStats, OpenMined và Weaviate
- Các dự án đám mây và cơ sở hạ tầng, chẳng hạn như cert-manager, NimbleEdge và Cilium
Chúng tôi không thu thập bất kỳ siêu dữ liệu nào về các dự án (chẳng hạn như ngày thành lập, phân bổ người đóng góp theo khu vực địa lý, số người đóng góp hoặc quy mô người dùng).
Chúng tôi đã yêu cầu các dự án cho biết họ sử dụng giấy phép nguồn mở nào.
Giới thiệu về các dự án tài liệu
Sự cố về tài liệu
Những vấn đề hàng đầu mà các tổ chức hy vọng có thể giải quyết bằng tài liệu trong chương trình năm 2022 bao gồm:
Xin lưu ý rằng các tổ chức có thể báo cáo nhiều vấn đề về tài liệu. Để biết thêm thông tin cụ thể, hãy xem trang kết quả của Mùa Tài liệu 2022. Trang này liên kết đến các đề xuất dự án gốc và nghiên cứu điển hình đầy đủ cho từng tổ chức.
Các loại tài liệu được tạo
Tài liệu hướng dẫn là loại tài liệu được đề cập nhiều nhất trong các nghiên cứu điển hình năm 2022.
Các loại tài liệu khác được đề cập trong các nghiên cứu điển hình bao gồm:
- Bắt đầu nhanh
- Bảng chú giải thuật ngữ
- Câu hỏi thường gặp
- Cơ sở kiến thức
- Thành phần
- Nội dung trên blog/mạng xã hội
- Hướng dẫn cho người bảo trì
Một số danh mục trong số này không rõ ràng và một dự án tài liệu có thể chứa nhiều loại hoặc tính năng tài liệu.
Để biết thêm thông tin cụ thể, hãy xem trang kết quả của Mùa Tài liệu 2022. Trang này liên kết đến các đề xuất dự án gốc và nghiên cứu điển hình đầy đủ cho từng tổ chức.
Ngân sách
Yêu cầu ngân sách trung bình là 11.679 đô la và mức trung bình là 12.150 đô la. Năm tổ chức yêu cầu và nhận được khoản tài trợ cao nhất hiện có (15.000 đô la Mỹ) và ba tổ chức yêu cầu mức tài trợ thấp nhất (từ 5.000 đến 7.000 đô la Mỹ).
Chỉ số
Những dự án được nêu trong các dự án điển hình sẽ nghiên cứu các chỉ số mà họ sử dụng để đánh giá mức độ thành công của các dự án tài liệu.
Các chỉ số hàng đầu được đề xuất bao gồm:
Các chỉ số được đề xuất khác bao gồm:
- Thêm nhiều tài liệu hơn để thu thập yêu cầu/đóng góp
- Phản hồi trực tiếp hơn trên các trang tài liệu
- Thời gian trên trang
- Vấn đề đã phát sinh (dưới dạng proxy để sử dụng)
- Người tham gia diễn đàn
- Số lượng đối tác/tình nguyện viên/người tích hợp
- Tỷ lệ thoát giảm
- Nâng cao nhận thức trong cộng đồng.
Do khoảng thời gian ngắn giữa lúc hoàn thành dự án viết kỹ thuật và gửi nghiên cứu điển hình, hầu hết nhóm thuần tập năm 2022 chưa thể thu thập đủ dữ liệu tại thời điểm gửi nghiên cứu điển hình để xác định xem các chỉ số ban đầu đã được đáp ứng hay chưa.
Khi nhận được câu trả lời cho các bản khảo sát tiếp theo vào năm 2023, chúng tôi sẽ cập nhật báo cáo này để bổ sung thông tin về những dự án đã đạt được các chỉ số hoặc sửa đổi các chỉ số.
Để biết thêm thông tin cụ thể, hãy xem trang kết quả của Mùa Tài liệu 2022. Trang này liên kết đến các đề xuất dự án gốc và nghiên cứu điển hình đầy đủ cho từng tổ chức.
Làm việc với các nhà biên kịch kỹ thuật
Trong chương trình Mùa tài liệu, các dự án dự kiến sẽ trực tiếp tuyển dụng, phỏng vấn, thuê và trả tiền cho nhà biên kịch kỹ thuật. Người viết nội dung kỹ thuật có thể tự thêm mình vào thư mục do Phần tài liệu duy trì trong kho lưu trữ GitHub của chúng tôi, nhưng nhân viên của Mùa Tài liệu không xem xét hoặc đề xuất người viết nội dung kỹ thuật.
Các phương pháp hay nhất để tuyển dụng người viết nội dung kỹ thuật cho dự án nguồn mở
Các dự án được yêu cầu chia sẻ các phương pháp hay nhất về việc tuyển dụng, tuyển dụng và làm việc với các nhà biên tập kỹ thuật. Các đề xuất hàng đầu là:
Tuyển dụng
- Phỏng vấn ít ứng viên hơn và sử dụng một buổi thực hành trực tiếp, thay vì chỉ xem xét sơ yếu lý lịch
- Đánh giá hiệu quả của kỹ năng viết và giao tiếp so với khả năng sử dụng ngôn ngữ hoặc công cụ trong dự án
- Đặt câu hỏi trực tiếp về cách người viết nội dung kỹ thuật sẽ thu thập mọi kiến thức miền cần thiết để thực hiện dự án của bạn
- Những người nhiệt huyết với sứ mệnh của dự án và chia sẻ các giá trị nguồn mở cốt lõi sẽ có nhiều khả năng duy trì động lực trong suốt toàn bộ dự án
- Hãy cởi mở với các ứng viên từ khắp nơi trên thế giới vì sự đa dạng về quan điểm và hoàn cảnh sẽ giúp ích cho dự án của bạn. Tuy nhiên, hãy lưu ý rằng nếu có các nhà văn và người cố vấn ở quá nhiều múi giờ xung đột có thể bạn sẽ phải nỗ lực rất nhiều để duy trì việc giao tiếp hiệu quả
Số người cần tuyển
- Sử dụng hợp đồng nêu rõ sản phẩm/dịch vụ, lịch thanh toán và cam kết thời gian cụ thể
- Nếu dự án của bạn có nhiều ẩn số, hãy thêm một cột mốc cho hoạt động khám phá hoặc nghiên cứu, tách biệt với việc tạo tài liệu
Phối hợp và giao tiếp
- Lưu giữ quyết định ghi lại nhật ký cuộc họp để giúp mọi người làm việc trong dự án dễ dàng hiểu bối cảnh và các bước tiếp theo
- Nêu rõ nội dung liên lạc và tần suất liên lạc, đó có thể là cuộc gọi hằng tuần, email hằng ngày hoặc thông tin cập nhật trạng thái trong một kênh trò chuyện
- Sẵn sàng phản hồi nhanh chóng và đưa ra phản hồi rõ ràng bao gồm "lý do" chứ không chỉ "cái gì"
- Kết nối những người viết nội dung kỹ thuật với cộng đồng rộng lớn hơn nhằm cung cấp bối cảnh và giao lưu tác phẩm của họ
Quy trình và công cụ
- Tạo một quy trình lập tài liệu kéo dài sau Phần Tài liệu và cả cộng đồng có thể đóng góp
- Quy trình xem xét tài liệu sẽ mất ít nhất thời gian và công sức như xem xét mã; hãy đảm bảo bạn dành đủ thời gian cho việc này
Một số đề xuất đã được chỉnh sửa và thu gọn để cho rõ ràng.
Như trong chương trình năm 2021, hầu hết người viết nội dung kỹ thuật trong Phần Tài liệu năm 2022 đã nộp đơn trực tiếp cho các tổ chức mà họ hợp tác.
Các vấn đề thường gặp khi hợp tác với người viết nội dung kỹ thuật
Trong chương trình năm 2022, có ít dự án báo cáo vấn đề khi hợp tác với tác giả kỹ thuật của họ. Vấn đề lớn nhất là việc người viết nội dung kỹ thuật không thể hoàn thành chương trình này, do bệnh tật, đảm nhận công việc toàn thời gian hoặc không thể đáp ứng cam kết thời gian.
Một dự án báo cáo rằng dự án tài liệu của họ phụ thuộc vào công việc được thực hiện trong Google Summer of Code và rằng những phần phụ thuộc đó rất khó quản lý. Một dự án khác gặp khó khăn khi phần cứng mà người viết kỹ thuật của họ cần để ghi lại đã bị Bộ Quốc phòng tại quốc gia của tác giả tịch thu và không thể nhập được.
Khảo sát tiếp theo
Chúng tôi sẽ gửi 3 bản khảo sát tiếp theo cho những người tham gia năm 2022 vào tháng 5, tháng 8 và tháng 11 năm 2023. Chúng tôi sẽ cập nhật kết quả cho phần này khi nhận được kết quả.
Câu hỏi trong tương lai
Như thường lệ, càng tìm hiểu nhiều tài liệu trong nguồn mở, chúng ta càng muốn học hỏi nhiều!
Trong các mùa giải tới, chúng tôi hy vọng có thể:
- Thu thập thêm siêu dữ liệu của dự án để tìm mối tương quan giữa độ tuổi của dự án, quy mô cộng đồng hoặc nhu cầu về ngôn ngữ và tài liệu
- Phân tích các dự án tài liệu để xem liệu chúng có thể được khái quát hoá thành các mẫu có thể chia sẻ hay không
- Phát triển tiêu chí chấm điểm để phỏng vấn tác giả kỹ thuật trong các dự án nguồn mở
Mặc dù có nhiều câu hỏi muốn điều tra, nhưng chúng tôi cũng muốn tôn trọng thời gian của những quản trị viên và nhà bảo trì dự án nguồn mở tham gia vào Phần Tài liệu. Ưu tiên hàng đầu của chương trình là hỗ trợ các dự án giải quyết vấn đề liên quan đến tài liệu.