Giai đoạn hiện tại:
Kết quả đã được công bố. Xem tiến trình.
Hãy sử dụng hướng dẫn này làm mẫu để tạo đề xuất dự án của tổ chức.
PROPOSAL TITLE – organization name
Tiêu đề đề xuất phải ngắn gọn và cụ thể. “Cập nhật Hướng dẫn dành cho cộng tác viên ORGNAME” là một tiêu đề đề xuất hay. Nội dung “Cải tiến tài liệu” thì quá mơ hồ; còn “Cập nhật các Mục 5,7,23,99 của Hướng dẫn dành cho cộng tác viên, Tạo câu hỏi thường gặp và Tạo hướng dẫn về văn phong” thì quá dài.
Giới thiệu về tổ chức của bạn
Trong phần này, hãy giới thiệu về tổ chức hoặc dự án của bạn trong một vài đoạn văn ngắn. Dự án của bạn giải quyết vấn đề gì? Người dùng và người đóng góp của bạn là ai? Tổ chức hoặc dự án của bạn đã hoạt động được bao lâu? Hãy cung cấp một số bối cảnh để giúp chúng tôi hiểu vì sao việc tài trợ cho đề xuất của bạn sẽ tạo ra tác động tích cực trong ngành nguồn mở và trên thế giới.
GloriousPickle (phiên bản hiện tại 1.2.3, phát hành đầu tiên vào năm 2009) là một thư viện được MIT cấp phép để dễ dàng tính toán tỷ lệ hoàn hảo của muối, đường, giấm và gia vị cho mọi loại rau dưa có thể, với số lượng khác nhau, từ một quả dưa chuột con đơn độc cho đến các kiện hàng chở củ cải. Những người đóng góp của chúng tôi là những người đam mê dưa muối từ khắp nơi trên thế giới. Người dùng của chúng tôi là các đầu bếp tại gia, đầu bếp nhà hàng và những người làm việc trong lĩnh vực kho vận cho các công ty và tổ chức chế biến thực phẩm lớn. Người dùng lớn nhất của chúng tôi là một tổ chức giúp các ngân hàng thực phẩm biến rau củ có thời hạn sử dụng ngắn thành các lọ dưa chua có thời hạn sử dụng lâu, giúp những người đói ở nhiều cộng đồng có thức ăn và giảm lãng phí thực phẩm. Ngoài ra, người dùng còn gửi cho chúng tôi các chỉ số không bắt buộc về việc họ sử dụng GloriousPickle. Chúng tôi dùng GloriousPickle để tạo ra PickleSet, một tập dữ liệu lớn dùng để tạo các công thức dưa góp mới bằng công nghệ học máy.
Giới thiệu về dự án của bạn
Vấn đề của dự án
Hãy cho chúng tôi biết về vấn đề mà dự án của bạn sẽ giúp giải quyết. Tại sao việc giải quyết vấn đề này lại quan trọng đối với tổ chức hoặc dự án của bạn?
Người dùng muốn thêm thông tin về các loại gia vị mới và các nguyên liệu khác (đặc biệt là nguyên liệu của các món ăn không phải của Châu Âu) vào công cụ GloriousPickle. Rất tiếc, quy trình thêm thông tin này không được ghi chép rõ ràng, nghĩa là những người đóng góp tiềm năng phải mở một vấn đề trong dự án để được trợ giúp (hoặc họ chỉ cần từ bỏ hoàn toàn). Quy trình này cũng giả định rằng những người đóng góp đã quen thuộc với quy trình yêu cầu kéo và GitHub, mặc dù nhiều người dùng của chúng tôi không phải là nhà phát triển chuyên nghiệp.
Chúng tôi càng có nhiều thông tin về thành phần thì GloriousPickle càng hữu ích cho tất cả người dùng!
Phạm vi của dự án
Cho chúng tôi biết về tài liệu mà tổ chức của bạn sẽ tạo, cập nhật hoặc cải thiện. Nếu bạn cố tình không làm một số công việc, hãy thêm thông tin đó vào. Hãy cung cấp thời gian ước tính và cho biết liệu bạn đã xác định được tình nguyện viên trong tổ chức và người viết kỹ thuật để làm việc với dự án của mình hay chưa.
Dự án GloriousPickle (có tên mã là PicklePlus) sẽ:
- Kiểm tra tài liệu hiện có và tạo nhật ký về sự cố của tài liệu hiện tại cho 3 trường hợp sử dụng hàng đầu (thêm thành phần mới, thêm thành phần biến thể và cập nhật hoặc sửa thông tin về một thành phần).
- Sử dụng nhật ký về sự cố để hiểu những thiếu sót trong tài liệu, tạo tài liệu cập nhật cho các trường hợp sử dụng hàng đầu.
- Tạo một "bảng tra cứu" nhanh để giúp những người mới đóng góp hiểu rõ về yêu cầu gộp và GitHub, từ đó có thể sử dụng quy trình của chúng tôi.
- Kết hợp ý kiến phản hồi của người kiểm thử tài liệu (người tình nguyện trong dự án) và cộng đồng GloriousPickle rộng lớn hơn.
- Làm việc với nhóm phát hành để cập nhật tài liệu trên trang web GloriousPickle, đồng thời tạo một quy trình để đảm bảo tài liệu luôn đồng bộ với công cụ cập nhật.
Công việc nằm ngoài phạm vi của dự án này:
- Dự án này sẽ không tạo quy trình liên kết chéo giữa các cách viết hoặc tên khác nhau cho cùng một thành phần.
- Dự án này sẽ không tạo bất kỳ hướng dẫn nào trên GitHub; thay vào đó, bản tóm tắt sẽ liên kết đến tài liệu có liên quan và hữu ích.
Chúng tôi có hai ứng viên viết nội dung kỹ thuật phù hợp cho dự án này và dự kiến sẽ mất 3 tháng để hoàn tất công việc này. GloriousPickle PickleDocs SIG và @GloriousPicklePat (đơn vị bảo trì cốt lõi của API thêm thành phần) đã cam kết hỗ trợ dự án này.
Đo lường mức độ thành công của dự án
Làm cách nào để biết tài liệu mới đã giúp giải quyết vấn đề của bạn? Bạn sẽ sử dụng những chỉ số nào và theo dõi những chỉ số đó như thế nào?
GloriousPickle nhận được trung bình 10 yêu cầu kéo mỗi quý để thêm hoặc cập nhật các thành phần mới (được gắn thẻ "thành phần"). Phần lớn các yêu cầu kéo này (>60%) là của những người đóng góp trước đó. Chúng tôi tin rằng tài liệu cải tiến này sẽ mang lại nhiều yêu cầu lấy dữ liệu hơn và nhiều yêu cầu lấy dữ liệu hơn từ cộng tác viên mới. Vì hầu hết cộng tác viên tích cực của chúng tôi đều bắt đầu bằng cách thêm thành phần, nên chúng tôi cũng cho rằng việc cải thiện tài liệu này sẽ giúp thu hút thêm nhiều cộng tác viên tích cực hơn.
Chúng tôi sẽ theo dõi hai chỉ số (số lượng yêu cầu kéo liên quan đến thành phần và số lượng yêu cầu kéo của người đóng góp mới) hằng tháng sau khi tài liệu được phát hành. Chúng tôi cũng sẽ theo dõi số người đóng góp đã đóng góp tổng cộng hơn 3 lần, bắt đầu từ hàng quý sau khi xuất bản tài liệu.
Chúng tôi sẽ xem dự án là thành công nếu sau khi phát hành tài liệu mới:
- Số lượng yêu cầu kéo liên quan đến thành phần tăng thêm 20%
- Số lượng yêu cầu kéo từ những người đóng góp mới tăng thêm 15%
- Số lượng người đóng góp đã đóng góp >3 lần tăng thêm 10% (bắt đầu từ quý sau khi tài liệu được xuất bản)
Dòng thời gian
Bạn ước tính công việc này sẽ mất bao lâu? Bạn có thể chia nhỏ các nhiệm vụ của người viết nội dung công nghệ theo tháng/tuần không?
Dự án này sẽ mất khoảng 6 tháng để hoàn thành. Sau khi tuyển dụng nhà văn kỹ thuật, chúng tôi sẽ dành một tháng để hướng dẫn nhà văn kỹ thuật, sau đó chuyển sang kiểm tra và nhật ký về sự cố, đồng thời dành vài tháng cuối cùng để tập trung vào việc tạo tài liệu.
| Ngày | Mục tác vụ |
|---|---|
| Tháng 5 | Hướng |
| Tháng 6 đến tháng 8 | Kiểm tra tài liệu hiện có và tạo nhật ký về sự cố |
| Tháng 9 – tháng 10 | Tạo tài liệu |
| Tháng 11 | Hoàn thành dự án |
Ngân sách dự án
Nguyên tắc chung
- Bạn có thể đưa ngân sách vào đề xuất hoặc dưới dạng một đường liên kết riêng. Nếu ngân sách của bạn có ít hơn 10 mục, chúng tôi khuyên bạn nên đưa ngân sách đó vào đề xuất của mình.
- Tất cả ngân sách phải được tính bằng đô la Mỹ. Chúng tôi dự kiến khoản tài trợ sẽ dao động từ 5.000 đến 15.000 USD; nếu dự án của bạn nằm ngoài phạm vi đó, vui lòng cung cấp thêm thông tin để giải thích lý do về ngân sách của bạn.
- Chúng tôi dự kiến phần lớn ngân sách của bạn (tối thiểu 60-70%) sẽ được phân bổ cho người viết nội dung kỹ thuật làm việc trên dự án của bạn. Bạn nên lập ngân sách theo từng dự án nếu có thể.
- Chúng tôi mong muốn các dự án nguồn mở sử dụng các công cụ nguồn mở bất cứ khi nào có thể; nếu dự án của bạn hoàn toàn cần có tài chính để mua giấy phép hoặc hỗ trợ phần mềm độc quyền, vui lòng giải thích lý do cho số tiền đó.
- Các chi phí khác có thể phát sinh bao gồm:
- Công việc thiết kế để tạo thương hiệu, biểu trưng, mẫu hoặc các thành phần thiết kế khác cho trang web tài liệu của bạn
- Số tiền tối thiểu (<200 USD) để mua quà tặng cho dự án (áo phông hoặc hình dán cho người tham gia). Nếu bạn sử dụng biểu trưng Google Season of Docs, biểu trưng đó phải đi kèm với tên hoặc biểu trưng của dự án hoặc tổ chức của bạn. Quà tặng của bạn không được sử dụng tên Google.
- Khoản thù lao tối thiểu cho những tình nguyện viên đảm nhận vai trò cố vấn hoặc hướng dẫn quan trọng trong dự án (bạn không nên trả quá 500 đô la Mỹ cho mỗi tình nguyện viên)
- Khoản quyên góp cho các dự án nguồn mở khác không được vượt quá 10% tổng ngân sách của bạn.
- Bao gồm các mục ngân sách khác nếu cần, cùng với lý do cho số tiền cần tìm. Nội dung giải thích về chi phí phải nêu rõ cách khoản chi tiêu đó sẽ góp phần vào sự thành công của toàn bộ dự án.
Ngân sách mẫu
| Mục ngân sách | Số tiền | Tổng số đang chạy | Ghi chú/lý do |
|---|---|---|---|
| Kiểm tra kỹ thuật viên viết, cập nhật, kiểm tra và xuất bản tài liệu mới về quy trình thêm nguyên liệu cho GloriousPickle | 5.000 | 5.000 | |
| Trợ cấp cho tình nguyện viên | 500 | 6.500 | 3 khoản trợ cấp cho tình nguyện viên, mỗi khoản 500 |
| Áo thun của dự án (10 chiếc áo) | 150,00 | 6650,00 | |
| Kỳ lân bơm hơi khổng lồ (phiên bản 4,5 mét) | 99,99 | 6.749,99 | Chúng tôi sẽ tặng mô hình thú nhồi bông hình kỳ lân cho nhóm trả lời câu hỏi của người viết nội dung kỹ thuật nhanh nhất trong thời gian phát triển dự án |
| TỔNG CỘNG | 6.749,99 |
Thông tin khác
Thêm vào đây mọi thông tin bổ sung có liên quan đến đề xuất của bạn.
Kinh nghiệm trước đây với nhà văn kỹ thuật hoặc tài liệu: Nếu bạn hoặc bất kỳ người cố vấn nào của bạn từng làm việc với nhà văn kỹ thuật hoặc từng phát triển tài liệu, hãy đề cập đến điều này trong đơn đăng ký. Mô tả tài liệu mà bạn đã tạo và cách bạn làm việc với nhà văn kỹ thuật. Ví dụ: mô tả mọi quy trình xem xét mà bạn đã sử dụng hoặc cách kỹ năng của người viết kỹ thuật hữu ích cho dự án của bạn. Giải thích cách trải nghiệm trước đây có thể giúp bạn làm việc với một nhà văn kỹ thuật trong Google Season of Docs.
Trước đây khi bạn tham gia Mùa giải Tài liệu, Google Summer of Code hoặc các chương trình khác: Nếu bạn hoặc bất kỳ cố vấn nào của bạn từng tham gia Mùa hè mã của Google hoặc một chương trình tương tự, hãy đề cập đến việc này trong đơn đăng ký. Mô tả thành tích của bạn trong chương trình đó. Giải thích cách trải nghiệm này có thể ảnh hưởng đến cách bạn làm việc trong Google Season of Docs.