Giai đoạn hiện tại:
Phát triển tài liệu. Xem 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 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 phù hợp. "Cải tiến về tài liệu" quá mơ hồ; "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, câu hỏi thường gặp và hướng dẫn tạo phong cách" 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 lý do khiến 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à thế giới.
GloriousPickle (phiên bản 1.2.3 hiện tại, bản phát hành đầu tiên vào năm 2009) là một thư viện được MIT cấp phép, giú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 muối, với số lượng từ một quả dưa chuột con đơn độc cho đến những hàng tàu 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 và người dùng của chúng tôi là các đầu bếp gia đình, đầu bếp nhà hàng và những người làm việc trong lĩnh vực 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 những loại rau củ tươi sống thành những lọ dưa muối ổn định, giúp phục vụ những người đói ở 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 sử dụng GloriousPickle để tạo một tập dữ liệu lớn để tạo các công thức nấu món muối chua mới thông qua công nghệ học máy.
Giới thiệu về dự án của bạn
Sự cố 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 nguyên liệu 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. Thật không may, quá trình thêm thông tin này không được ghi lại đầy đủ, nghĩa là 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ọ sẽ từ bỏ hoàn toàn). Quy trình này cũng giả định rằng các cộng tác viên đã 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, thì GloriousPickle càng hữu ích với tất cả người dùng!
Phạm vi của dự án
Hãy cho chúng tôi biết 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 một số nội dung cố tình không được thực hiện, hãy bao gồm cả thông tin đó. Hãy đưa ra thời gian ước tính và xác định xem bạn đã xác định được tình nguyện viên của tổ chức và người viết kỹ thuật để thực hiện dự án hay chưa.
Dự án GloriousPickle (tên mã là PicklePlus) sẽ:
- Kiểm tra tài liệu hiện có và tạo nhật ký ma sát của tài liệu hiện tại cho ba trường hợp sử dụng hàng đầu (thêm nguyên liệu mới, thêm thành phần 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 lỗ hổng 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 cộng tác viên mới làm quen với yêu cầu 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 từ 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.
- 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 về sau.
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 ra 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 ra 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 hiện có liên quan và hữu ích.
Chúng tôi có hai ứng viên viết bài kỹ thuật giỏi cho dự án này và chúng tôi ước tính sẽ mất ba tháng để hoàn thành. GloriousPickle PickleDocs SIG và @GloriousPicklePat (đơn vị bảo trì cốt lõi của API để thêm nguyên liệu vào) đã cam kết hỗ trợ dự án này.
Đo lường mức độ thành công của dự án
Làm thế nào để biết rằng tài liệu mới đã giúp bạn giải quyết được vấn đề? Chị 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 trong mỗi quý để thêm hoặc cập nhật các nguyên liệu mới (được gắn thẻ là "nguyên liệu chế biến"). Phần lớn trong số các yêu cầu lấy dữ liệu này (hơn 60%) là từ 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ẽ mang lại nhiều yêu cầu lấy dữ liệu hơn và yêu cầu lấy dữ liệu từ những 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 việc 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.
Sau khi xuất bản tài liệu, chúng tôi sẽ theo dõi 2 chỉ số (số yêu cầu lấy dữ liệu liên quan đến thành phần và số yêu cầu lấy dữ liệu từ những người đóng góp mới). 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 lần, bắt đầu từ hằng 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ẽ xem là dự án thành công nếu:
- Số lượng yêu cầu lấy dữ liệu liên quan đến thành phần tăng thêm 20%
- Số lượng yêu cầu lấy dữ liệu từ những cộng tác viên mới tăng 15%
- Số lượng người đóng góp có trên 3 nội dung đóng góp tăng 10% (bắt đầu vào quý sau khi tài liệu được xuất bản)
Dòng thời gian
Theo bạn thì công việc này sẽ mất bao lâu? Bạn có thể phân tích công việc của nhà văn kỹ thuật theo tháng hoặc theo tuần không?
Dự án này sẽ mất khoảng 6 tháng để hoàn thành. Sau khi thuê người viết công nghệ, chúng tôi sẽ dành một tháng để định hướng 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 để 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ý phiền hà |
| 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ể đư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 mục này 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 trong khoảng từ 5000 đến 15000 USD; 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 để xác minh ngân sách của bạn.
- Chúng tôi dự kiến phầ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 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 ngân sách để cấp giấy phép hoặc hỗ trợ phần mềm độc quyền, hãy nêu rõ 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 tài sản thiết kế khác cho trang web tài liệu của bạn
- Số tiền tối thiểu (<US$200) để quà tặng cho 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 Google Tài liệu, thì biểu trưng này phải đi kèm với biểu trưng hoặc tên của dự án hoặc tổ chức của bạn. Quà tặng của bạn có thể không 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 đề nghị không quá 500 đô la Mỹ cho mỗi tình nguyện viên, vui lòng lưu ý)
- Các khoản đóng góp cho các dự án nguồn mở khác không nên 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 bạn muốn. Lý do chi tiêu nên nhấn mạnh cách chi tiêu sẽ đóng góp vào sự thành công của dự án nói chung.
Ngân sách mẫu
| Mục ngân sách | Số Lượng | Tổng số đang chạy | Lưu ý/giải thích |
|---|---|---|---|
| Kiểm tra kỹ thuật cho 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 tình nguyện viên được trợ cấp x 500 tình nguyện viên mỗi người |
| Áo thun dự án (10 chiếc áo thun) | 150 | 6650,00 | |
| 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 nội dung kỹ thuật nhanh nhất trong suốt thời gian phát triển dự án |
| TỔNG CỘNG | 6749,99 |
Thông tin khác
Cung cấp tại đâ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 tác giả hoặc tài liệu kỹ thuật: Nếu bạn hoặc bất kỳ 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 đơn đăng ký. Mô tả tài liệu mà bạn tạo ra và cách bạn làm việc với người viết nội dung kỹ thuật. Ví dụ: mô tả quy trình đánh giá mà bạn đã sử dụng hoặc sự hữu ích của 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 những lợi ích mà trải nghiệm cũ này có thể giúp bạn làm việc với người viết nội dung kỹ thuật trong Phần Google Tài liệu.
Trước đây đã tham gia Google 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 việc 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 đó. Giải thích xem 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 Google Phần Tài liệu.