Giai đoạn hiện tại:
Kết quả đã công bố
tiến trình.
Sử dụng hướng dẫn này làm mẫu để tạo đề xuất dự án cho tổ chức của bạn.
TIÊU ĐỀ ĐỀ XUẤT - tên tổ chức
Tiêu đề đề xuất của bạn nên 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 phù hợp. "Những điểm cải tiến về tài liệu" quá mơ hồ; "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" quá dài.
Giới thiệu về tổ chức của bạn
Trong phần này, hãy cho chúng tôi biết 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 đã tồn tại bao lâu? Hãy cung cấp 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 nguồn mở và trên thế giới.
GloriousPickle (phiên bản 1.2.3 hiện tại, phát hành lần đầ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ệ muối, đường, giấm và gia vị hoàn hảo cho mỗi loại rau dưa muối, với số lượng từ một quả dưa chuột con đơn độc cho đến các khối lượng củ cải. Người đóng góp của chúng tôi là những người đam mê dưa chọn từ khắp nơi trên thế giới và người dùng của chúng tôi là đầu bếp tại gia, đầu bếp nhà hàng và những người làm việc trong bộ phận hậu cần cho các công ty và tổ chức chế biến món ăn 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 những loại rau củ tươi sống thành những lọ dưa muối ổn định, giúp nuôi sống những người đói trong nhiều cộng đồng và giảm tình trạng 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 họ sử dụng GloriousPickle. Chúng tôi dùng công cụ này để tạo PickleSet, một tập dữ liệu lớn để tạo các công thức nấu dưa muối 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
Cho chúng tôi biết vấn đề mà dự án của bạn sẽ giúp giải quyết. Vì sao tổ chức hoặc dự án của bạn cần giải quyết vấn đề này?
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à nguyên liệu từ 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 lại đầy đủ, nghĩa là những người đóng góp tiềm năng phải mở ra một vấn đề trong dự án để yêu cầu trợ giúp (hoặc họ hoàn toàn từ bỏ). 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 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ề nguyên liệu chế biến thì GloriousPickle càng hữu ích với tất cả người dùng!
Phạm vi dự án của bạn
Hãy cho chúng tôi biết những 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 cố ý không thực hiện một số công việc, hãy bao gồm cả thông tin đó. Hãy gửi kèm thông tin ước tính về thời gian, cũng như xác định được tình nguyện viên của tổ chức và người viết nội dung kỹ thuật để thực hiện dự án hay không.
Dự án GloriousPickle (tên mã là PicklePlus) sẽ:
- Kiểm tra tài liệu hiện có và tạo một nhật ký nhanh chóng của tài liệu hiện tại cho ba trường hợp sử dụng phổ biến nhất (thêm nguyên liệu mới, thêm nguyên liệu biến thể và cập nhật hoặc chỉnh sửa thông tin về nguyên liệu).
- Hãy dùng nhật ký ma sát làm hướng dẫn để tìm hiểu những thiếu sót trong tài liệu và 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ản tóm tắt" ngắn gọn để giúp những người đóng góp chưa từng lấy yêu cầu và GitHub để giúp 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 những người kiểm thử tài liệu (tình nguyện viê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 một quy trình để đồng bộ 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 nguyên liệu.
- 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 những tài liệu có liên quan và hữu ích hiện có.
Chúng tôi có hai ứng viên viết kỹ thuật xuất sắc cho dự án này và dự kiến sẽ mất ba tháng để hoàn thành 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 nguyên liệu) đã cam kết hỗ trợ dự án.
Đ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 bạn giải quyết vấn đề? Anh sẽ sử dụng những chỉ số nào và theo dõi các chỉ số đó như thế nào?
GloriousPickle nhận trung bình 10 yêu cầu kéo mỗi quý để thêm hoặc cập nhật các nguyên liệu mới (được gắn thẻ "nguyên liệu"). Phần lớn các yêu cầu kéo này (> 60%) là từ 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ẽ tạo ra 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ừ những cộng tác viên mới. Vì hầu hết những người đóng góp tích cực của chúng tôi đều bắt đầu bằng cách thêm thành phần nguyên liệu, 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 người đóng góp tích cực hơn.
Chúng tôi sẽ theo dõi hai chỉ số (số yêu cầu lấy dữ liệu liên quan đến nguyên liệu và số yêu cầu lấy dữ liệu từ người đóng góp mới) hằng tháng sau khi tài liệu được xuất bản. Chúng tôi cũng sẽ theo dõi số người đóng góp tổng thể đã đóng góp hơn 3 lần, bắt đầu từ quý sau khi tài liệu được xuất bản.
Sau khi xuất bản tài liệu mới, chúng tôi sẽ coi dự án là thành công nếu:
- Số lượng yêu cầu lấy dữ liệu liên quan đến nguyên liệu tăng 20%
- Số lượng yêu cầu lấy dữ liệu từ những người đóng góp mới tăng 15%
- Số lượng cộng tác viên đã đóng góp nhiều hơn 3 lần tăng 10% (bắt đầu từ quý sau khi tài liệu được xuất bản)
Lịch trình
Bạn dự tính việc này sẽ mất bao lâu? Bạn có thể chia nhỏ các nhiệm vụ của biên tập viên công nghệ theo tháng/tuần không?
Bản thân dự án này sẽ mất khoảng sáu tháng để hoàn thành. Sau khi thuê người viết công nghệ, chúng ta sẽ dành một tháng để tìm hiểu về hướng dành cho người viết công nghệ, sau đó chuyển sang nhật ký kiểm tra và phiền hà, đồng thời dành vài tháng cuối cùng để tập trung 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ý nhanh chóng |
| Tháng 9 – Tháng 10 | Tạo tài liệu |
| Tháng 11 | Hoàn tất dự án |
Ngân sách dự án
Nguyên tắc chung
- Bạn có thể thêm 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 thêm mục đó 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 trong khoảng từ 5000 USD đến 15000 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 để 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 người viết kỹ thuật đang thực hiện dự án của bạn. Nếu có thể, bạn nên lập ngân sách theo từng dự án.
- Chúng tôi mong muốn các dự án nguồn mở sử dụng công cụ nguồn mở bất cứ khi nào có thể. Nếu dự án của bạn thực sự cần đến nguồn vốn để có giấy phép phần mềm độc quyền hoặc yêu cầu hỗ trợ, vui lòng nêu rõ số tiền đó.
- Các chi phí khác có thể phát sinh bao gồm:
- Thiết kế nhằm tạo thương hiệu, biểu trưng, mẫu hoặc các phần tử 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) để quà tặng dự án (áo thun hoặc nhãn dán cho người tham gia). Nếu bạn sử dụng biểu trưng Phần Tài liệu, thì biểu trưng đó phải đi kèm với tên hoặc biểu trưng 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.
- Trợ cấp 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 (chúng tôi khuyến nghị không quá 500 đô la cho mỗi tình nguyện viên, vui lòng lưu ý)
- 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.
- 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 mong muốn. Lý giải chi phí phải nêu bật mức độ đóng góp của khoản chi phí đó vào 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ú/giải thích |
|---|---|---|---|
| Kiểm tra kỹ thuật với người viết, cập nhật, thử nghiệm và xuất bản tài liệu mới về quy trình thêm nguyên liệu cho GloriousPickle | 5000 | 5000 | |
| Trợ cấp cho tình nguyện viên | 500 | 6500.00 | 3 trợ cấp tình nguyện viên x 500 mỗi khoản |
| Áo thun dài tay (10 áo) | 150.00 | 6650 | |
| Kỳ lân bơm hơi khổng lồ (phiên bản 15 feet) | 99,99 | 6749,99 | Chúng tôi sẽ đưa chú kỳ lân có thể bơm hơi cho nhóm trả lời các câu hỏi của người viết kỹ thuật một cách nhanh nhất trong giai đoạn phát triển dự án |
| TỔNG SỐ | 6749,99 |
Thông tin bổ sung
Thêm mọi thông tin bổ sung có liên quan đến đề xuất của bạn vào đây.
Có kinh nghiệm làm việc với người viết hoặc tài liệu kỹ thuật: 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 người viết nội dung 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 ứng dụng của bạn. Mô tả tài liệu bạn đã tạo ra và cách bạn làm việc với tác giả về kỹ thuật. Ví dụ: hãy mô tả mọi quy trình đánh giá mà bạn đã sử dụng hoặc mức độ hữu ích của các kỹ năng của người viết nội dung kỹ thuật đối với dự án của bạn. Giải thích trải nghiệm trước đây có thể giúp bạn làm việc với một người viết nội dung kỹ thuật như thế nào trong Phần Tài liệu.
Trước đây đã tham gia Season of 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ỳ người cố vấn nào của bạn đã 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ý của bạn. Hãy mô tả thành tích của bạn trong chương trình đó. Hãy giải thích trải nghiệm này có thể ảnh hưởng như thế nào đến cách bạn làm việc trong Phần Tài liệu.