Giai đoạn hiện tại:
Đã công bố kết quả. Hãy xem dòng thời gian.
Sử dụng ví dụ này để giúp bạn tạo báo cáo nghiên cứu điển hình của riêng mình.
PicklePlus: Ghi lại công cụ đóng góp GloriousPickle
Tổ chức hoặc dự án: Glorious Pickle liên kết đến trang web chính của tổ chức hoặc dự án của bạn tại đây
Mô tả tổ chức: 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 có thể, với số lượng từ một quả dưa chuột con đơn độc cho đến các tải củ cải.
Tác giả: optional: liệt kê tác giả của nghiên cứu điển hình; sử dụng tên người dùng nếu được yêu cầu
Tuyên bố vấn đề/Bản tóm tắt đề xuất
Bạn đang cố gắng giải quyết vấn đề gì bằng tài liệu mới hoặc đã cải tiến? Hãy liên kết đến trang đề xuất trên trang web dự án của bạn, nếu có thể.
Việc thêm nguyên liệu vào cơ sở dữ liệu về nguyên liệu của công cụ GloriousPickle tốn nhiều thời gian và phức tạp, ngoài ra công cụ này cũng không có tài liệu chứng minh hiệu quả. Nhiều người đóng góp không có kinh nghiệm sử dụng git hoặc đưa ra yêu cầu kéo. Điều này có nghĩa là GloriousPickle có những lỗ hổng nghiêm trọng trong dữ liệu về thành phần nguyên liệu và khiến công cụ của chúng tôi trở nên kém hữu ích hơn. Bằng cách cải thiện tài liệu về cách thêm các nguyên liệu mới, chúng tôi hy vọng sẽ khuyến khích được những người đóng góp mới và tự chọn thêm nhiều nguyên liệu khác!
Nội dung mô tả dự án
Tạo đề xuất
Bạn nghĩ ra cách nào để đưa ra đề xuất cho Phần Tài liệu trong Google? Tổ chức của bạn sử dụng quy trình nào để quyết định một ý tưởng? Anh thu thập và kết hợp ý kiến phản hồi như thế nào?
GloriousPickle PickleDocs SIG biết đến chương trình Phần tài liệu trong Google thông qua một bài đăng trên Twitter tại Văn phòng chương trình nguồn mở của Google. SIG đã thảo luận về chương trình này trong cuộc họp hai tuần một lần và nhất trí đưa ra đề xuất. Hai thành viên của SIG (@KimChiCook và @Dillicious) đã tình nguyện xây dựng bản dự thảo đề xuất để xem xét trong cuộc họp tiếp theo.
Sau khi PickleDocs SIG đồng ý về bản dự thảo đề xuất, một email được gửi tới dự án rộng hơn để đề nghị đưa ra ý kiến phản hồi. 14 thành viên cộng đồng đã đưa ra ý kiến phản hồi, trong đó có @GloriousPicklePat, nhà duy trì API để thêm nguyên liệu. @GloriousPicklePat đã tình nguyện tham gia hỗ trợ trong suốt chương trình.
Sau khi thảo luận và kết hợp ý kiến phản hồi nhận được, đề xuất đã được gửi đến Ban chỉ đạo dự án GloriousPickle để bỏ phiếu. Cả năm thành viên của GPPS đã bỏ phiếu +1 để gửi đề xuất và đơn đăng ký, và @VinegarViv đã đồng ý giúp tạo tài khoản Open Collective cần thiết để tham gia chương trình và giám sát các khoản thanh toán.
Ngân sách
Thêm một mục ngắn vào ngân sách của bạn. Bạn đã ước tính công việc này như thế nào? Có chi phí ngoài dự kiến nào không? Mức chi tiêu của bạn có phải thấp hơn phần thưởng tài trợ không? Bạn đã phân bổ ngân sách đúng cách hay bạn đã lập ngân sách cho một số mục nhiều hơn/ít hơn/không cần thiết? Bạn có tiền nào khác ngoài Phần Tài liệu trên Google mà bạn có thể sử dụng không?
Hai thành viên của GloriousPickle PickleDocs SIG hoạt động trong vai trò người viết nội dung kỹ thuật (một ở Châu Âu và một ở Argentina). Họ giúp chúng tôi ước tính công việc và tìm ngân sách dự án tương tự, so sánh công việc đề xuất nháp mà họ đã thực hiện trước đây. Chúng tôi cũng còn lại 1.000 USD tiền tài trợ không hạn chế từ hội nghị PicklePals năm 2019 mà chúng tôi đã phân bổ cho dự án.
Một khoản chi phí ngoài dự kiến là để giúp người viết kỹ thuật của chúng tôi thuê một điểm phát sóng Wi-Fi, vì họ đang ở khu vực chịu ảnh hưởng của các vụ cháy rừng và bị mất kết nối Internet tại nhà. Cuối cùng, chúng tôi cũng đã phát ít áo phông hơn cho người tham gia so với kế hoạch nên mọi việc đã được cân bằng.
Ngoài ra, chúng tôi quyết định trả thù lao cho một cộng tác viên của GloriousPickle, @Piccalily (người từng là một biên tập viên chuyên nghiệp trong suốt cuộc đời không hề tự chọn của mình) để giúp họ chỉnh sửa nội dung và hiệu đính tài liệu do người viết kỹ thuật tạo ra.
Người tham gia
Ai đã làm việc trong dự án này (sử dụng tên người dùng nếu người tham gia yêu cầu)? Bạn tìm và thuê người viết nội dung kỹ thuật bằng cách nào? Bạn tìm thấy những tình nguyện viên hoặc người tham gia trả phí khác bằng cách nào? Họ có những vai trò gì? Có ai bỏ ngang không? Bạn đã tìm hiểu được những gì về việc tuyển dụng, giao tiếp và quản lý dự án?
Nhóm nòng cốt làm việc trong dự án này là:
- @Dillicious, @KimChiCook (PickleDocs SIG)
- @Piccalily (copyeditor)
- @GherKen, @VinegarViv (trợ giúp quản trị viên, GPPSC)
- @BBChips, @GloriousPicklePat (chuyên gia nghiên cứu chuyên ngành)
- Sam Scribe (người viết kỹ thuật)
Chúng tôi đã tìm thấy Sam Scribe thông qua danh sách kho lưu trữ Phần trên GitHub của Google Tài liệu. Chúng tôi nghĩ rằng kinh nghiệm của họ (Sam đã làm việc cho một tạp chí ẩm thực cũng như viết tài liệu cho các trang web) rất phù hợp với dự án của chúng tôi. Sam tham gia cuộc gọi hai tuần một lần của PickleDocs SIG và trò chuyện với chúng tôi về dự án, đưa ra một số đề xuất rất có giá trị mà chúng tôi đã đưa vào đề xuất. Chúng tôi cũng liên hệ với 2 nhà văn kỹ thuật khác mà chúng tôi biết thông qua mạng lưới của các thành viên SIG. Tuy nhiên, cả hai kênh này đều không hoạt động trong khoảng thời gian diễn ra chương trình.
Vì múi giờ của Sam chỉ trùng với vài giờ so với hầu hết các thành viên của PickleDocs SIG, chúng tôi đã gửi một cuộc gọi trong diễn đàn thảo luận dành cho những người chọn lọc ở múi giờ của Sam và quen thuộc với quy trình thêm nguyên liệu. @BBChips đã tình nguyện trả lời các câu hỏi cho Sam và giúp họ tìm các chuyên gia khác khi cần. @GloriousPicklePat cũng đã tình nguyện giúp Sam hiểu cấu trúc cơ bản của công cụ này cũng như các thông báo lỗi có thể xảy ra từ API, đồng thời cung cấp trợ giúp cho GitHub và git.
Thật không may, giữa chương trình, @VinegarViv đã phải rút lui khỏi dự án vì lý do cá nhân. Thành viên GPPSC @GherKen đã tăng cường xử lý các câu hỏi về quản trị và thanh toán.
Sau một số câu hỏi bị bỏ lỡ (GloriousPickle sử dụng một phiên bản Slack miễn phí và đôi khi cuộc thảo luận diễn ra quá nhanh đến mức chúng tôi mất cuộc trò chuyện vì giới hạn lưu trữ luân phiên), chúng tôi biết rằng mình nên lưu giữ danh sách các câu hỏi đang chạy trong một tài liệu dùng chung (chúng tôi đã sử dụng một tài liệu dùng chung trên Google Tài liệu). Thành viên PickleDocs SIG kiểm tra tài liệu trước mỗi cuộc họp và đảm bảo nhận được câu trả lời trước khi cuộc họp kết thúc. Sam đã trực tiếp liên hệ với @BBChips để đặt câu hỏi khẩn cấp.
Chúng tôi rất vui khi được làm việc với Sam và Sam. Ngoài việc cập nhật tài liệu về GloriousPickle, bản thân chúng tôi lại còn trở thành một người đam mê chọn lọc!
Lịch trình
Đưa ra thông tin tổng quan ngắn gọn về tiến trình của dự án (cho biết ngày kết thúc ước tính hoặc các mốc trung gian nếu dự án đang diễn ra).
Trong khi chúng tôi chờ chương trình Phần Tài liệu trên Google thông báo về các tổ chức tham gia, các thành viên của PickleDocs SIG tìm kiếm những tác phẩm trước đây mà chúng tôi cho rằng sẽ hữu ích cho Sam. Trong hơn một tháng, chúng tôi đã tìm thấy một số ghi chú từ nỗ lực cập nhật tài liệu đã bị trì hoãn trước đó. Ngoài ra, chúng tôi cũng đã xem xét các phần của tài liệu kiểm tra mức độ hoàn thiện của tài liệu trong kho lưu trữ tài liệu mở của Google.
Sau khi nhận được tin vui là chúng tôi được chọn tham gia Mùa giải Google Tài liệu, Sam và PickleDocs SIG gặp nhau và xây dựng một lịch trình cụ thể:
| Sân khấu | Hoàn thành bởi |
|---|---|
| Xem lại kết quả kiểm tra tài liệu | Ngày 7 tháng 5 |
| Các trường hợp sử dụng nhật ký ma sát 3 | 14/5 |
| Xem nhật ký những phiền toái qua @GloriousPicklePat và @BBChips, cũng như trả lời các câu hỏi | Ngày 28 tháng 5 |
| Bản nháp đầu tiên của trường hợp sử dụng 1 của tài liệu mới cập nhật | Ngày 25 tháng 6 |
| Bản nháp trường hợp sử dụng 1 do @GloriousPicklePat và @KimChiCook xem xét | Ngày 2 tháng 7 |
| Bản nháp đầu tiên của trường hợp sử dụng 2 của tài liệu mới cập nhật | Ngày 2 tháng 7 |
| Bản nháp trường hợp sử dụng 2 do @GloriousPicklePat và @Dillicious xem xét | Ngày 9 tháng 7 |
| Bản nháp đầu tiên của trường hợp sử dụng 3 của tài liệu mới cập nhật | Ngày 9 tháng 7 |
| Bản nháp trường hợp sử dụng 3 do @Dillicious và @KimChiCook xem xét | Ngày 16 tháng 7 |
| Giải đáp mọi thắc mắc cho mọi trường hợp sử dụng | Ngày 30 tháng 7 |
| Hầu hết PickleDocs SIG đi nghỉ từ ngày 1 đến ngày 20 tháng 8 | -- |
| Bắt đầu thử nghiệm tài liệu mới trong cộng đồng (tài liệu được xuất bản dưới dạng bản nháp trên trang web GloriousPickle) | Ngày 21 tháng 8 |
| Kết hợp ý kiến phản hồi về thử nghiệm | Ngày 10 tháng 9 |
| Sao chép và hiệu đính tài liệu mới | Ngày 17 tháng 9 |
| Xoá trạng thái bản nháp của tài liệu, tài liệu chính thức ra mắt | Ngày 28 tháng 9 |
| Đã tạo quy trình cập nhật tài liệu | Ngày 1 tháng 11 |
| Nghiên cứu điển hình này đã tạo | Ngày 8 tháng 11 |
| Đã gửi nghiên cứu điển hình | Ngày 16 tháng 11 |
Trong ngân sách đề xuất, chúng tôi ước tính người viết kỹ thuật sẽ dành từ 10-15 giờ mỗi tuần để làm việc cho dự án. Sam lưu giữ hồ sơ về thời gian sử dụng và trung bình 11,5 giờ mỗi tuần.
Kết quả
Thông tin nào được tạo, cập nhật hoặc thay đổi? Cung cấp đường liên kết đến tài liệu đã xuất bản (nếu có). Có sản phẩm nào trong đề xuất mà chưa được tạo không? Hãy liệt kê cả những thành phần đó.
Có 3 trường hợp sử dụng chính đã được ghi lại kèm theo hướng dẫn sử dụng đầy đủ cho người dùng:
Cách thêm nguyên liệu mới vào GloriousPickle
Cách thêm thành phần biến thể vào GloriousPickle
Cách cập nhật hoặc chỉnh sửa nguyên liệu trong GloriousPickle
Những bản hướng dẫn này cũng bổ sung các mẫu yêu cầu lấy dữ liệu mới để giúp bạn đóng góp dễ dàng hơn.
Ngoài ra, trong dự án, Sam đã tạo một Bảng thuật ngữ nhỏ của Pickle về các thuật ngữ họ đã học, cũng được xuất bản trên trang web của dự án GloriousPickle.
Chúng tôi đã bổ sung hướng dẫn cập nhật những hướng dẫn này cho người dùng vào dự án wiki.
Chúng tôi đã tạo một bản tóm tắt cho những cộng tác viên mới sử dụng GitHub để giúp họ sử dụng các quy trình và công cụ của chúng tôi. Tuy nhiên, sau khi xem xét các tài nguyên có sẵn, chúng tôi có thể tạo một bản tóm tắt cho một dự án khác.
Chỉ số
Bạn chọn chỉ số nào để đo lường mức độ thành công của dự án? Bạn có thu thập được các chỉ số đó không? Các chỉ số này có tương quan tốt hay kém với kết quả mà bạn mong muốn cho dự án không? Các chỉ số của bạn có thay đổi kể từ lúc bạn đề xuất không?
Trong đề xuất của mình, chúng tôi đã đề xuất 2 chỉ số:
- số yêu cầu lấy liên quan đến nguyên liệu
- số lượng yêu cầu lấy dữ liệu từ cộng tác viên mới
Trong tháng 9 (cả tháng đầu tiên kể từ khi xuất bản tài liệu dự thảo), chúng tôi nhận thấy số lượng yêu cầu lấy nguyên liệu liên quan đến nguyên liệu tăng 5% (từ ngày 20 tháng 8 lên ngày 21 tháng 9) và chúng tôi thấy có 3 cộng tác viên mới đưa ra tổng cộng 4 yêu cầu (so với 2 người đóng góp mới đưa ra 2 yêu cầu trong tháng 8). Chúng tôi dự định theo dõi những chỉ số này hằng tháng.
Kể từ ngày 1 tháng 1, chúng tôi cũng sẽ theo dõi tổng số người đóng góp đã đóng góp hơn 3 nội dung, bắt đầu từ hằng quý sau khi tài liệu được xuất bản.
Có vẻ như chúng tôi tin rằng tài liệu mới này đã tạo ra sự khác biệt trong việc cho phép những người đóng góp mới thêm vào cơ sở dữ liệu về nguyên liệu GloriousPickle – một người đóng góp mới đã đề cập trong phần bình luận về PR của họ mà họ đã thử trước đây nhưng chưa hoàn tất quá trình cập nhật vì họ không hiểu quy trình.
Phân tích
Thành quả đạt được là gì? Điều gì ngoài dự kiến? Bạn gặp phải trở ngại hay khó khăn nào? Bạn có coi dự án của mình thành công không? Tại sao hoặc tại sao không? (Nếu còn quá sớm để thông báo, hãy giải thích thời điểm bạn có thể đánh giá mức độ thành công của dự án.)
Chúng tôi rất hài lòng với kết quả của dự án Phần Google Tài liệu và coi đó là một thành công. Tài liệu mới này trình bày rõ ràng và hữu ích. Chúng tôi nhận thấy số lượng yêu cầu lấy dữ liệu liên quan đến nguyên liệu và số lượng yêu cầu lấy dữ liệu từ những người đóng góp mới đã tăng lên.
Chúng tôi cũng rất vui khi gần như toàn bộ cộng đồng GloriousPickle tham gia, thông qua việc đưa ra phản hồi về đề xuất ban đầu và thử nghiệm tài liệu mới ở dạng bản nháp.
Chúng tôi đã phải đối mặt với một vài rào cản bất ngờ — chúng tôi rất biết ơn vì các vụ cháy rừng ở trạng thái của Sam không gây ra bất kỳ thiệt hại nào nhiều hơn việc Internet ngừng hoạt động! Ngoài ra, chúng tôi rất tiếc vì đã mất @VinegarViv khỏi dự án; chúng tôi chúc cho cô ấy và gia đình những điều tốt đẹp nhất và hy vọng sớm gặp lại cô ấy.
Một điều mà chúng tôi không nhận ra cho đến khi Sam bắt đầu soạn thảo tài liệu là có nhiều từ ngữ và từ viết tắt liên quan đến dưa chọn, sẽ lạ lẫm với những người tham gia dự án của chúng tôi mà không có nền tảng nào cần trau chuốt. Tuy nhiên, Sam đã quyết định duy trì một danh sách những thuật ngữ lạ rồi định nghĩa chúng thông qua quá trình nghiên cứu riêng của họ cũng như bằng cách nhờ các thành viên trong cộng đồng giải thích và tham khảo. Bảng chú giải thuật ngữ Pickle này sẽ là một sự trợ giúp rất lớn trong việc chào đón nhiều người hơn đến với cộng đồng Pickle trong tương lai.
Tóm tắt
Trong 2-4 đoạn văn, hãy tóm tắt trải nghiệm của bạn về dự án. Nêu bật những điều bạn đã học được và những gì bạn sẽ chọn làm khác đi trong tương lai. Bạn sẽ đưa ra lời khuyên gì cho các dự án khác đang cố gắng giải quyết vấn đề tương tự bằng tài liệu?
Tóm lại, trải nghiệm của chúng tôi thật sự quá độc đáo! Chúng tôi đã đạt được thành quả về tài liệu và các chỉ số dường như phù hợp với mục tiêu của chúng tôi.
Một phần quan trọng tạo nên thành công của dự án này là rất may mắn khi chúng tôi được làm việc với nhà văn kỹ thuật của mình, Sam Scribe. [Tôi không viết về lĩnh vực này – Sam] Mặc dù Sam không có kiến thức về lĩnh vực dự đoán hoặc kinh nghiệm với GitHub, nhưng vì là một nhà viết kỹ thuật giàu kinh nghiệm, nhưng Sam rất thoải mái khi khám phá một lĩnh vực mới, đặt câu hỏi và nghiên cứu. Sam nhanh chóng chọn ra những công cụ giúp dự án (chúng tôi dùng bảng kanban để theo dõi công việc) mà còn cả những câu đùa vui nhộn của chúng tôi! Chúng tôi rất vui vì Sam đã phát hiện ra bọ và chúng tôi đã "đóng chai" chúng trong cộng đồng.
Các dự án khác nên:
- Giữ cho các đề xuất của bạn nhỏ gọn và có thể quản lý. (Ban đầu, chúng tôi muốn đưa tài liệu về việc sử dụng công cụ ước tính với máy móc ngâm lô công nghiệp vào đề xuất, và chỉ bỏ qua vì một trong các thành viên cộng đồng của chúng tôi tham gia sâu vào máy móc dưa chọn nguồn mở sẽ viết luận văn tiến sĩ của mình trong chương trình.) Cuối cùng chúng tôi đã có quá nhiều việc để làm Sam bận rộn!
- Hãy khai thác các mạng lưới của bạn khi tìm kiếm một người viết nội dung kỹ thuật. Mời mọi người trong cộng đồng của bạn đưa ra đề xuất. Mặc dù chúng tôi đã tìm thấy Sam thông qua Google Season of Tài liệu trên GitHub, nhưng chúng tôi cảm thấy tự tin khi làm việc với họ vì chúng tôi đã trò chuyện với một số người trong thời gian đăng ký.
- Chào mừng người viết nội dung kỹ thuật tham gia cộng đồng của bạn! Sam cho chúng tôi biết rằng thái độ nhiệt tình của những người đón nhận sự tôn vinh đã giúp họ dễ dàng đặt câu hỏi.
- Giúp người viết kỹ thuật có kỹ năng nguồn mở. Sam chưa từng sử dụng git trước đây, nhưng sau khi xem một số hướng dẫn, họ đã tăng tốc nhanh chóng. Lúc đầu, Sam lo lắng về việc cộng đồng sẽ nhận được bao nhiêu ý kiến phản hồi và cách kết hợp ý kiến đó, nhưng mô hình "sự đồng thuận thô" của cộng đồng ("có được sự đồng thuận khi giải quyết xong tất cả các vấn đề nhưng không nhất thiết phải được điều chỉnh") đã giúp Sam tự tin giải quyết các lời chỉ trích bằng kiến thức chuyên môn về kỹ thuật viết.
Phụ lục
Nếu bạn có các tài liệu khác muốn liên kết (ví dụ: nếu bạn đã tạo hợp đồng hợp tác với người viết nội dung kỹ thuật mà bạn muốn chia sẻ, hoặc các mẫu cho dự án tài liệu hay các tài nguyên tài liệu mở khác, bạn có thể liệt kê và liên kết chúng tại đây). Phụ lục cũng là nơi phù hợp để liệt kê các đường liên kết đến mọi công cụ tài liệu hoặc tài nguyên bạn đã sử dụng, hoặc là nơi để bạn gửi lời cảm ơn hay lời cảm ơn có thể không phù hợp với các phần trên.
Thư cảm ơn
Nhóm chúng tôi muốn thông báo về những người và thông tin sau:
- @Dillicious muốn cảm ơn người bạn đời của cô và cũng là Đài phát nhạc Hip Hop đơn giản
- @KimChiCook muốn cảm ơn 할머ation của anh ấy đã hướng dẫn anh ấy cách nấu dưa muối
- @Piccalily muốn cảm ơn Hướng dẫn về phong cách trực tuyến của Chicago
- @GherKen muốn cảm ơn ba đứa con của ông vì đã ăn tất cả các món dưa góp mà ông làm
- @VinegarViv muốn cảm ơn những người còn lại trong nhóm vì đã tiếp thêm sức mạnh cho cô khi cô ngừng việc
- @BBChips muốn cảm ơn món bánh wafers Caramel ngon nhất của Tunnock
- @GloriousPicklePat cảm ơn SIG của PickleDocs tham gia dự án này
- Sam Scribe muốn cảm ơn toàn bộ cộng đồng GloriousPickle, nhưng đặc biệt là những người Picklers đã gửi cho họ những lọ đóng hộp trong thời gian thiếu hụt vào mùa hè năm 2021, bắt đầu họ lên đường với nhiều loại dưa chua ngon lành!