Giai đoạn hiện tại:
Nghiên cứu điển hình đã xuất bản. Xem tiến trình.
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 các vấn đề về dự án bằng tài liệu
- Cho phép người viết nội dung kỹ thuật có cơ hội 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à 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ở
Bạn có thể xem thêm thông tin về Mùa tài liệu trên trang web của chương trình.
Tổng quan về chương trình năm 2022
Cách hoạt động của Season of Docs
Trong chương trình 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úp giải quyết vấn đề của họ
- Cách dự án sẽ đo lường 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 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 của Chương trình viết 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ê người viết nội dung 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 này trả tiền cho các nhà văn kỹ thuật thông qua Open Collective. Ngân sách và khoản thanh toán dự án được công khai; ngân sách được đưa vào các đề xuất dự án của tổ chức trên trang web của Season of Docs và các khoản thanh toán được hiển thị trong tài khoản Open Collective của Season of Docs.
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ài đánh giá hằng tháng trong thời gian tham gia chương trình và 3 bài khảo sát tiếp nối hằng quý trong năm sau khi hoàn tất chương trình.
Điểm 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 và tỷ lệ thoát giảm khoảng 30%" – Casbin
"Một kết quả thú vị 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 để đảm nhận vai trò lãnh đạo trong cộng đồng của chúng tôi. Cả hai cộng tác viên này hiện đang dẫn dắt các cuộc họp nhóm làm việc và cộng đồng, đồng thời đó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 hai nhà văn kỹ thuật tài năng, điều này rất khó thực hiện trong một quy trình thiết lập thông thường. Họ tiếp tục đóng góp tích cực cho OpenMined về hệ điều hành 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 cũng dễ hiểu hơn nhiều đối với những người mới làm quen với phương pháp quang phổ khối tính toán. Để minh hoạ điều này: khoản tài trợ của CZI cũng cung cấp trợ cấp cho những cá nhân có hoàn cảnh khó khăn 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 dự án đăng ký và 30 dự án đã hoàn tất thành công chương trình. Trong số 31 tổ chức được chấp nhận, 17 tổ chức là những người đăng ký lại.
31 dự án được chấp nhận đã thuê 58 người viết nội dung kỹ thuật. Hơn 190 nhà văn kỹ thuật đã bày tỏ 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ữ GitHub của Season of Docs.
Đố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 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 Chương trình viết 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, chẳng hạn như CERN-HSF và SymPy
- Ứ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 siêu dữ liệu nào về các dự án (chẳng hạn như ngày thành lập, vị trí đị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 giấy phép nguồn mở mà họ sử dụng.
Giới thiệu về các dự án tài liệu
Vấn đề về tài liệu
Sau đây là một số vấn đề hàng đầu mà các tổ chức muốn giải quyết bằng tài liệu trong chương trình năm 2022:
Xin lưu ý rằng 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 chi tiết, hãy xem trang kết quả của Chương trình Tài liệu 2022. Trang này có đường liên kết đến các đề xuất dự án ban đầu 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 đến 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 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 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 chi tiết, hãy xem trang kết quả của Chương trình Tài liệu 2022. Trang này có đường liên kết đến các đề xuất dự án ban đầu 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à giá trị trung bình là 12.150 đô la. 5 tổ chức đã yêu cầu và nhận được khoản tài trợ cao nhất hiện có (15.000 USD) và 3 tổ chức yêu cầu khoản tài trợ thấp nhất (từ 5.000 đế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 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:
- Các yêu cầu/đóng góp khác về tài liệu
- Ý kiến 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
- Các vấn đề được nêu ra (dưới dạng proxy để sử dụng)
- Người tham gia diễn đàn
- Số lượng đối tác/người tình nguyện/tích hợp
- Giảm tỷ lệ thoát
- Tăng mức độ nhận biết trong cộng đồng.
Do khoảng thời gian ngắn giữa thời điểm hoàn thành dự án viết kỹ thuật và thời điểm gửi nghiên cứu điển hình, hầu hết nhóm thuần tập năm 2022 không 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ọ đã đáp ứng các chỉ số ban đầu 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 để thêm thông tin về những dự án đã đạt được chỉ số hoặc sửa đổi chỉ số của họ.
Để biết thêm thông tin chi tiết, hãy xem trang kết quả của Chương trình Tài liệu 2022. Trang này có đường liên kết đến các đề xuất dự án ban đầu 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à văn 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 các nhà văn kỹ thuật. Người viết tài liệu kỹ thuật có thể tự thêm mình vào thư mục do Season of Docs duy trì trong kho lưu trữ GitHub của chúng tôi, nhưng nhân viên của Season of Docs không kiểm tra hoặc đề xuất người viết tài liệu kỹ thuật.
Các phương pháp hay nhất để thuê 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 để 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à tổ chức một buổi thực hành trực tiếp thay vì chỉ xem xét CV
- Ưu tiên kỹ năng giao tiếp bằng văn bản và lời nói hơn là khả năng thành 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 nhiệt tình 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ở có nhiều khả năng sẽ duy trì được động lực trong suốt dự án
- Hãy mở rộng cơ hội cho những người đăng ký từ khắp nơi trên thế giới, vì sự đa dạng về quan điểm và nền tảng sẽ giúp ích cho dự án của bạn. Tuy nhiên, hãy lưu ý rằng việc có các nhà văn và cố vấn ở quá nhiều múi giờ xung đột có thể khiến bạn phải nỗ lực nhiều hơn để duy trì hoạt động giao tiếp hiệu quả
Tuyển dụng
- Sử dụng hợp đồng nêu rõ sản phẩm, lịch thanh toán và cam kết về thời gian cụ thể
- Nếu dự án của bạn có nhiều thông tin chưa biết, hãy thêm một mố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 nhật ký cuộc họp để mọi người tham gia dự án dễ dàng nắm được bối cảnh và các bước tiếp theo
- Hãy nêu rõ hình thức giao tiếp dự kiến và tần suất giao tiếp, 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 nhanh chóng và đưa ra ý kiến phản hồi rõ ràng, bao gồm cả "lý do" chứ không chỉ "vấn đề"
- Kết nối các nhà văn kỹ thuật với cộng đồng rộng lớn hơn để cung cấp cho họ bối cảnh và để xã hội hoá công việc của họ
Quy trình và công cụ
- Tạo một quy trình biên soạn tài liệu kéo dài sau chương trình Mùa tài liệu và toàn bộ cộng đồng có thể đóng góp
- Việc xem xét tài liệu sẽ mất ít nhất là thời gian và cũng chuyên sâu như việc 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à rút gọn để rõ ràng hơn.
Giống như chương trình năm 2021, hầu hết các nhà văn kỹ thuật trong Chương trình viết tài liệu 2022 đều trực tiếp đăng ký 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 người viết nội dung kỹ thuật
Ít dự án báo cáo vấn đề khi làm việc với các nhà văn kỹ thuật trong chương trình năm 2022. Vấn đề lớn nhất là các nhà văn kỹ thuật không thể hoàn thành chương trình do ốm đau, làm 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 đang được thực hiện trong Google Summer of Code và các phần phụ thuộc đó 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 ở quốc gia của người viết tịch thu và không thể nhập.
Bài khảo sát tiếp theo
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 khi nhận được kết quả.
Câu hỏi trong tương lai
Như mọi khi, chúng ta càng tìm hiểu nhiều về tài liệu trong nguồn mở, thì chúng ta càng muốn tìm hiểu nhiều hơn!
Trong các mùa sau này, chúng tôi hy vọng có thể:
- 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 ngôn ngữ và nhu cầu tài liệu
- Phân tích các dự án tài liệu để xem liệu có thể tổng quát hoá các dự án đó thành các mẫu có thể chia sẻ hay không
- Phát triển tiêu chí để phỏng vấn các 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 Chương trình viết 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 đề về tài liệu.