Season of Docs là một chương trình 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 Season of Docs là:
- Hỗ trợ các dự án nguồn mở giải quyết vấn đề của dự án bằng tài liệu
- Tạo cơ hội cho nhà văn kỹ thuật tích luỹ kinh nghiệm về nguồn mở
- Nâng cao nhận thức về nguồn mở, tài liệu và hoạt động viết 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ở
Bạn có thể xem thêm thông tin về Season of Docs trên trang web của chương trình.
Tổng quan về chương trình năm 2022
Cách thức hoạt động của Season of Docs
Trong Season of Docs, các tổ chức đă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ẽ sử dụng tài liệu để giải quyết vấn đề của họ
- Cách dự án đo lường mức độ hiệu quả của tài liệu (chỉ số)
- Lịch trình cho 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 trong 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 Season of Docs hiểu rõ dự án và vấn đề của tổ chức
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ê nhà văn kỹ thuật. Season of Docs sử dụng Open Collective để tài trợ cho các tổ chức, và các tổ chức sẽ trả thù lao cho nhà văn kỹ thuật thông qua Open Collective. Ngân sách và khoản thanh toán của dự á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 Season of Docs và các khoản thanh toán có trên tài khoản Open Collective của Season of Docs.
Các tổ chức được coi là đã hoàn tất thành công 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 các bản đánh giá hằng tháng trong thời gian diễn ra chương trình và 3 cuộc khảo sát theo dõi hằng quý trong năm tiếp theo sau khi chương trình kết thúc.
Nội dung nổi bật 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 gần như tăng gấp đôi, đồng thời tỷ lệ thoát giảm khoảng 30%" – Casbin
"Một kết quả đáng mừng của dự án này là việc [các nhà văn kỹ thuật của chúng tôi] đã phát triển thành những người có vai trò lãnh đạo trong cộng đồng của chúng tôi. Cả hai người đóng góp này hiện đang dẫn dắt các cuộc họp của 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 tuyển dụng được 2 nhà văn kỹ thuật tài năng (điều rất khó thực hiện trong một môi trường thông thường). Họ vẫn đang là những người đóng góp tích cực cho hệ điều hành của OpenMined và chúng tôi đã có trải nghiệm làm việc tuyệt vời với họ." – OpenMined
"Ngoài ra, hướng dẫn mới này dễ hiểu hơn nhiều đối với những người mới bắt đầu sử dụng phương pháp khối phổ tính toán. Để minh hoạ điểm này: khoản tiền tài trợ của CZI cũng cung cấp khoản trợ cấp cho những cá nhân từng chịu nhiều thiệt thòi và một số người nhận giải thưởng đã sử dụng hướng dẫn OpenMS mới để bắt đầu giai đoạn thực tập kéo dài 6 tuần và đã đưa ra những đánh giá tích cực về 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 Season of Docs đã chấp nhận 31 dự án trong số 67 đơn đăng ký và 30 dự án đã hoàn thành thành công chương trình này. Trong số 31 tổ chức được chấp nhận, có 17 tổ chức đã từng đăng ký.
31 dự án được chấp nhận đã thuê 58 chuyên viên viết kỹ thuật. Hơn 190 nhà văn kỹ thuật đã thể hiện sự quan tâm đến việc tham gia chương trình bằng cách thêm thông tin liên hệ và đường liên kết đến danh mục đầu tư của họ trong kho lưu trữ Season of Docs trên 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 nội dung/tài liệu 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 này
- 90% tổ chức cảm thấy dự án 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 Season of Docs 2022 đại diện cho nhiều dự án nguồn mở. Nhóm 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, chẳng hạn 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 về đá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ạm vi địa lý của người đóng góp, số lượng người đóng góp hoặc quy mô cơ sở 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
Vấn đề về giấy tờ
Các vấn đề hàng đầu mà các tổ chức hy vọng giải quyết được 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 Season of Docs 2022. Trang này liên kết đến các đề xuất dự án ban đầu và nghiên cứu trường hợp đầy đủ cho từng tổ chức.
Các loại tài liệu đã 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 nghiên cứu điển hình bao gồm:
- Bắt đầu nhanh
- Bảng 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 dành cho người duy trì
Một số danh mục trong số này là danh mục không rõ ràng và một dự án tài liệu duy nhất có thể chứa nhiều loại tài liệu hoặc tính năng.
Để biết thêm thông tin cụ thể, hãy xem trang kết quả của Season of Docs 2022. Trang này liên kết đến các đề xuất dự án ban đầu và nghiên cứu trường hợp đầ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 USD và ngân sách trung vị là 12.150 USD. 5 tổ chức đã yêu cầu và nhận được khoản tiền tài trợ cao nhất hiện có (15.000 USD) và 3 tổ chức yêu cầu khoản tiền tài trợ thấp nhất (từ 5.000 USD đến 7.000 USD).
Chỉ số
Các dự án được nêu trong nghiên cứu điển hình của họ là những chỉ số mà họ đang 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ố được đề xuất hàng đầu là:
Các chỉ số khác được đề xuất bao gồm:
- Nhiều yêu cầu kéo/đóng góp tài liệu hơn
- Ý kiến phản hồi trực tiếp hơn trên các trang tài liệu
- Thời gian dành cho trang
- Các vấn đề được nêu ra (được dùng làm chỉ số đại diện cho mức sử dụng)
- Người tham gia diễn đàn
- Số lượng đối tác/tình nguyện viên/đơn vị tích hợp
- Giảm tỷ lệ thoát
- Nâng cao mức độ nhận biết trong cộng đồng.
Do thời gian giữa lúc hoàn thành dự án viết tài liệu kỹ thuật và lúc gửi nghiên cứu điển hình quá ngắn, nên hầu hết nhóm năm 2022 đều 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 họ có đạt được các chỉ số ban đầu hay không.
Khi nhận được câu trả lời cho các cuộc 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 để thêm thông tin về những dự án đã đạt được chỉ số hoặc điều chỉnh chỉ số.
Để biết thêm thông tin cụ thể, hãy xem trang kết quả của Season of Docs 2022. Trang này liên kết đến các đề xuất dự án ban đầu và nghiên cứu trường hợp đầy đủ cho từng tổ chức.
Làm việc với chuyên viên viết tài liệu kỹ thuật
Trong chương trình Season of Docs, các dự án dự kiến sẽ trực tiếp tuyển dụng, phỏng vấn, thuê và trả lương cho nhà văn kỹ thuật. Các nhà văn kỹ thuật có thể tự thêm mình vào danh bạ do Season of Docs duy trì trong kho lưu trữ GitHub của chúng tôi, nhưng nhân viên Season of Docs không kiểm tra hoặc đề xuất nhà văn kỹ thuật.
Các phương pháp hay nhất để tuyển dụng nhà văn kỹ thuật cho dự án nguồn mở
Các dự án được yêu cầu chia sẻ những phương pháp hay nhất để tuyển dụng, thuê và làm việc với các nhà văn 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 CV
- Đánh giá cao kỹ năng giao tiếp bằng văn bản và lời nói hơn là trình độ thông thạo ngôn ngữ hoặc công cụ của dự án
- Đặt câu hỏi trực tiếp về cách nhà văn kỹ thuật sẽ thu thập mọi kiến thức chuyên môn cần thiết để làm việc với dự án của bạn
- Những người có nhiệt huyết với sứ mệnh của dự án và chia sẻ các giá trị cốt lõi của nguồn mở sẽ có nhiều khả năng duy trì động lực trong toàn bộ dự án
- Hãy mở rộng phạm vi tuyển người tham gia trên toàn thế giới, vì tính đa dạng về quan điểm và bối cảnh sẽ giúp ích cho dự án của bạn. Tuy nhiên, hãy lưu ý rằng việc có quá nhiều nhà văn và người cố vấn ở các múi giờ xung đột có thể đòi hỏi bạn phải nỗ lực hơn nữa để duy trì giao tiếp hiệu quả
Tuyển dụng
- Sử dụng hợp đồng nêu rõ sản phẩm bàn giao, lịch thanh toán và cam kết cụ thể về thời gian
- Nếu dự án của bạn có nhiều điểm chưa rõ, hãy thêm một cột mốc cho việc khám phá hoặc nghiên cứu riêng biệt với việc tạo tài liệu
Điều phối và giao tiếp
- Ghi lại các quyết định trong nhật ký cuộc họp để mọi người tham gia dự án đều có thể dễ dàng nắm được bối cảnh và các bước tiếp theo
- Nêu rõ tần suất và phương thức giao tiếp dự kiến, cho dù đó là cuộc gọi hằng tuần, email hằng ngày hay thông tin cập nhật trạng thái trong kênh trò chuyện
- Hãy phản hồi và đưa ra ý kiến phản hồi rõ ràng, trong đó có cả "lý do" chứ không chỉ "nội dung"
- Kết nối đội ngũ kỹ thuật viên viết tài liệu với cộng đồng rộng lớn hơn để cung cấp thông tin liên quan và chia sẻ công việc của họ
Quy trình và công cụ
- Tạo một quy trình lập tài liệu sẽ kéo dài sau chương trình Season of Docs và toàn bộ cộng đồng có thể đóng góp vào quy trình này
- Việc xem xét tài liệu sẽ mất ít nhất thời gian tương đương và cũng cần nhiều công sức như việc xem xét mã; hãy đảm bảo bạn có đủ thời gian cho việc này
Một số đề xuất đã được chỉnh sửa và rút gọn để cho rõ ràng.
Giống như chương trình năm 2021, hầu hết các nhà văn kỹ thuật trong Season of Docs 2022 đều đăng ký trực tiếp với các tổ chức mà họ hợp tác.
Các vấn đề thường gặp khi làm việc với chuyên viên viết tài liệu kỹ thuật
Trong chương trình năm 2022, ít dự án báo cáo vấn đề khi làm việc với các nhà văn kỹ thuật. Vấn đề lớn nhất là người viết tài liệu kỹ thuật không thể hoàn thành chương trình do bị bệnh, nhận công việc toàn thời gian hoặc không thể đáp ứng cam kết về 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 khuôn khổ Google Summer of Code và 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à nhà văn kỹ thuật của họ cần ghi lại bị Bộ Quốc phòng ở quốc gia của nhà văn tịch thu và không thể nhập khẩu.
Khảo sát theo dõi
Ba cuộc khảo sát tiếp theo sẽ được gửi đến 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 phần này bằng kết quả khi nhận được.
Câu hỏi trong tương lai
Như mọi khi, chúng ta càng tìm hiểu về tài liệu trong nguồn mở, chúng ta càng muốn tìm hiểu thêm!
Trong các mùa giải sau này, chúng tôi hy vọng sẽ:
- Thu thập thêm siêu dữ liệu dự án để tìm mối tương quan giữa tuổi 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 một bộ tiêu chí chấm điểm để phỏng vấn nhà văn kỹ thuật trong các dự án nguồn mở
Mặc dù có nhiều câu hỏi mà chúng tôi muốn tìm hiểu, nhưng chúng tôi cũng muốn tôn trọng thời gian của các quản trị viên và người duy trì dự án nguồn mở tham gia Season of Docs. Ư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 đề bằng tài liệu.