Giai đoạn hiện tại:
Hoàn thiện dự án. 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 cho cộng tác viên ORGNAME" là một tiêu đề đề xuất phù hợp. "Documentation Improvements" (Cải tiến tài liệu) quá mơ hồ; "Update Sections 5,7,23,99 of Contributor Guide, Create FAQ, and Create Style Guide" (Cập nhật các phần 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ề kiểu) 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 ngắn. Dự án của bạn giải quyết vấn đề gì? Người dùng và cộng tác viên 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ố thông tin để giúp chúng tôi hiểu lý do việc tài trợ cho đề xuất của bạn sẽ tạo ra tác động tích cực trong cộng đồng nguồn mở và trên thế giới.
GloriousPickle (phiên bản hiện tại là 1.2.3, bản phát hành đầu tiên vào năm 2009) là một thư viện được cấp phép MIT để dễ dàng tính toán tỷ lệ muối, đường, giấm và gia vị hoàn hảo cho mọi loại rau có thể làm dưa chuột, với số lượng từ một quả dưa chuột nhỏ đến một thùng hàng rau củ. Cộng tác viên của chúng tôi là những người đam mê dưa chua trên khắp thế giới, còn người dùng là các đầu bếp gia đình, đầu bếp nhà hàng và những người làm việc trong ngành hậu cầ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 dài, 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 gửi cho chúng tôi các chỉ số không bắt buộc về việc sử dụng GloriousPickle. Chúng tôi sử dụng các chỉ số này để tạo PickleSet, một tập dữ liệu lớn để tạo công thức dưa chua mới thông qua 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 có thể thêm thông tin về các loại gia vị mới và các thành phần khác (đặc biệt là các thành phần từ các nền ẩm thực không phải 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ọ sẽ bỏ cuộc hoàn toàn). Quy trình này cũng giả định rằng người đóng góp đã quen thuộc với quy trình yêu cầu lấy dữ liệu 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 nội dung 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ề thành phần).
- Sử dụng nhật ký ma sát làm hướng dẫn để hiểu rõ 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 các thay đổi mà bạn thực hiện vào mã nguồn ban đầu (yêu cầu kéo) và GitHub để họ 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 và tạo quy trình để đồng bộ hoá tài liệu với công cụ cập nhật trong tương lai.
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ảng nhớ sẽ liên kết đến tài liệu hiện có phù hợp và hữu ích.
Chúng tôi có hai ứng viên viết kỹ thuật giỏi cho dự án này và dự kiến sẽ mất 3 tháng để hoàn thành công việc này. GloriousPickle PickleDocs SIG và @GloriousPicklePat (người duy trì chính 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 đây. Chúng tôi tin rằng tài liệu cải tiến này sẽ dẫn đến nhiều yêu cầu kéo hơn và nhiều yêu cầu kéo hơn từ các 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 từ 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ố lượng cộng tác viên đã đóng góp tổng cộng hơn 3 nội dung, bắt đầu từ quý sau khi tài liệu được phát hành.
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 nhà văn công nghệ theo tháng hay tuần không?
Bản thân dự án này sẽ mất khoảng 6 tháng để hoàn tất. Sau khi tuyển dụng nhà văn kỹ thuật, chúng ta 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, bạn nên đưa ngân sách đó vào đề xuất.
- 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 đô la Mỹ; nếu dự án của bạn nằm ngoài phạm vi đó, hãy cung cấp thêm thông tin để chứng minh 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 nhà văn kỹ thuật phụ trách 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ó kinh phí để mua giấy phép hoặc hỗ trợ phần mềm độc quyền, hãy đưa ra lý do cho số tiền đó.
- Các khoản chi phí khác có thể 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) cho quà tặng của 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 đáng kể trong dự án (mỗi tình nguyện viên không nên nhận quá 500 USD)
- Các 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.
- Thê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 bạn yêu cầu. Nội dung giải thích về chi phí phải nêu rõ cách chi tiêu sẽ đóng góp 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, cập nhật, kiểm thử và phát hành tài liệu mới về quy trình thêm thành phần 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 phông của dự án (10 chiếc áo) | 150.00 | 6.650 | |
| 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.
Trải 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 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.
Từng tham gia Google Season of Docs, Google Summer of Code hoặc các chương trình khác: Nếu bạn hoặc bất kỳ người cố vấn nào của bạn từng tham gia Google Summer of Code hoặc một chương trình tương tự, hãy đề cập đến điều 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.