Giai đoạn hiện tại:
Kết quả đã được công bố. Xem tiến trình.
Hãy dùng ví dụ này để tạo báo cáo nghiên cứu điển hình của riêng bạn.
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
Nội dung mô tả về tổ chức: 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 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 có thể làm dưa chua, với số lượng từ một quả dưa chuột nhỏ đến một container chở đầy củ cải.
Tác giả: không bắt buộc: 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 đề/Tóm tắt đề xuất
Bạn muốn giải quyết vấn đề gì bằng tài liệu mới hoặc tài liệu cải tiến? 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 nguyên liệu của công cụ GloriousPickle tốn nhiều thời gian và phức tạp, đồng thời công cụ này không có tài liệu đầy đủ. Nhiều người muốn đóng góp không có kinh nghiệm sử dụng git hoặc tạo yêu cầu kéo. Điều này có nghĩa là GloriousPickle có những thiếu sót nghiêm trọng trong dữ liệu thành phần, khiến công cụ của chúng ta kém hữu ích. Bằng cách cải thiện tài liệu về cách thêm thành phần mới, chúng tôi hy vọng có thể khuyến khích những người đóng góp mới và có thêm nhiều món dưa!
Mô tả dự án
Tạo đề xuất
Bạn đã nghĩ ra đề xuất về Google Season of Docs như thế nào? Tổ chức của bạn đã sử dụng quy trình nào để quyết định một ý tưởng? Bạn đã thu thập và đưa ý kiến phản hồi vào dự án như thế nào?
GloriousPickle PickleDocs SIG đã nghe về chương trình Mùa tài liệu của Google thông qua một bài đăng trên Twitter của Văn phòng Chương trình nguồn mở của Google. Nhóm 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à đồng ý tạo một đề xuất. Hai thành viên của SIG (@KimChiCook và @Dillicious) đã tình nguyện soạn thảo bản đề xuất dự thảo để được xem xét trong cuộc họp tiếp theo.
Sau khi Nhóm đặc nhiệm PickleDocs đồng ý về bản dự thảo đề xuất, một email đã được gửi đến dự án rộng lớn hơn để yêu cầu ý kiến phản hồi. 14 thành viên trong cộng đồng đã đưa ra ý kiến phản hồi, trong đó có @GloriousPicklePat, người duy trì API thêm thành phần. @GloriousPicklePat đã tình nguyện trở thành một nguồn hỗ trợ trong chương trình.
Sau khi thảo luận và đưa ý kiến phản hồi vào, đề xuất này đã được gửi đến Ủy ban điều hành dự án GloriousPickle để bỏ phiếu. Cả 5 thành viên của GPPSC đều đồng ý gửi đề xuất và đơn đăng ký. @VinegarViv cũng đồ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 phần ngắn về 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? Bạn có chi tiêu ít hơn số tiền được cấp không? Bạn có phân bổ ngân sách đúng cách hay một số mục bạn đã lập ngân sách nhiều/ít/không cần thiết không? Bạn có thể sử dụng nguồn tài chính nào khác ngoài Google Season of Docs không?
Hai thành viên của GloriousPickle PickleDocs SIG) đều là người viết bài về 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 với công việc đề xuất dự thảo mà họ đã thực hiện trước đó. Chúng tôi cũng còn 1.000 đô la Mỹ tiền tài trợ không ràng buộc từ hội nghị PicklePals năm 2019 và đã phân bổ số tiền này cho dự án.
Một khoản chi phí ngoài dự kiến là giúp nhà văn kỹ thuật của chúng tôi thuê một điểm phát sóng Wi-Fi vì họ đang ở một khu vực chịu ảnh hưởng của đám cháy rừng và mất kết nối Internet tại nhà. Cuối cùng, chúng tôi cũng gửi ít áo phông hơn dự kiến cho người tham gia, nên mọi thứ đã cân bằng.
Ngoài ra, chúng tôi quyết định bồi thường cho một cộng tác viên của GloriousPickle, @Piccalily (từng là một biên tập viên chuyên nghiệp trong cuộc sống ngoài Pickle) để giúp biên tập và hiệu đính tài liệu do nhà văn kỹ thuật tạo.
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ê nhân viên viết nội dung kỹ thuật cho mình bằng cách nào? Bạn đã tìm thấy những người tình nguyện hoặc người tham gia có trả phí khác bằng cách nào? Họ có vai trò gì? Có ai đã thôi làm hội viên không? Bạn đã học được gì về việc tuyển dụng, giao tiếp và quản lý dự án?
Nhóm cốt lõi làm việc trên dự án này bao gồm:
- @Dillicious, @KimChiCook (PickleDocs SIG)
- @Piccalily (người biên tập nội dung)
- @GherKen, @VinegarViv (trợ giúp quản trị viên, GPPSC)
- @BBChips, @GloriousPicklePat (chuyên gia trong lĩnh vực)
- Sam Scribe (nhân viên viết tài liệu kỹ thuật)
Chúng tôi tìm thấy Sam Scribe thông qua danh sách Kho lưu trữ GitHub của Google Season of Docs. Chúng tôi cho rằng kinh nghiệm của họ (Sam từng 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à nói chuyện về dự án với chúng tôi, đưa ra một số đề xuất rất có giá trị mà chúng tôi đã đưa vào đề xuất này. Chúng tôi cũng đã liên hệ với hai nhà văn kỹ thuật khác mà chúng tôi biết thông qua mạng lưới của thành viên SIG, nhưng cả hai đều không có mặt 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 múi giờ của hầu hết các thành viên trong Nhóm chuyên gia PickleDocs một vài giờ, nên chúng tôi đã gửi lời kêu gọi trong diễn đàn thảo luận của mình cho những người dùng Pickles ở múi giờ của Sam và quen thuộc với quy trình thêm thành phần. @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 cấu trúc cơ bản của công cụ và thông báo lỗi có thể xảy ra từ API, đồng thời hỗ trợ về GitHub và git.
Thật không may, giữa chương trình @VinegarViv đã phải rút lại dự án vì lý do cá nhân. @GherKen, thành viên của GPPSC đã tăng cường xử lý các câu hỏi về quản trị và thanh toán.
Sau khi bỏ lỡ một số câu hỏi (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 khiến chúng tôi mất các cuộc trò chuyện do giới hạn lưu trữ luân phiên), chúng tôi nhận thấy rằng mình nên giữ danh sách các câu hỏi đang diễn ra trong một tài liệu dùng chung (chúng tôi đã sử dụng Google Tài liệu dùng chung). Các thành viên SIG PickleDocs đã kiểm tra danh sách này 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 có thể nhắn tin trực tiếp cho @BBChips để hỏi những câu hỏi cấp bách.
Chúng tôi rất vui khi được làm việc với Sam. Ngoài việc cập nhật tài liệu về GloriousPickle, Sam còn trở thành một người rất thích dùng pickle!
Dòng thời gian
Trình bày ngắn gọn tiến trình của dự án (cho biết ngày kết thúc dự kiến hoặc các mốc trung gian nếu dự án đang diễn ra).
Trong khi chờ chương trình Mùa Tài liệu của Google công bố các tổ chức tham gia, các thành viên của PickleDocs SIG đã tìm kiếm mọi tác phẩm trước đó mà chúng tôi cho rằng sẽ hữu ích với Sam. Trong khoảng thời gian một tháng, chúng tôi tìm thấy một số ghi chú trong nỗ lực cập nhật tài liệu đã bị trì trệ 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 độ hoàn thiện của tài liệu trong kho lưu trữ opendocs của Google.
Sau khi nhận được tin vui rằng chúng tôi đã được chọn tham gia Google Season of Docs, Sam và Nhóm đặc nhiệm PickleDocs đã gặp mặt và lên lịch sơ bộ:
| Sân khấu | Người hoàn thành |
|---|---|
| Kiểm tra tài liệu xem xét | Ngày 7 tháng 5 |
| 3 trường hợp sử dụng nhật ký ma sát | Ngày 14 tháng 5 |
| Xem lại nhật ký ma sát với @GloriousPicklePat và @BBChips, trả lời truy vấn | Ngày 28 tháng 5 |
| Bản nháp đầu tiên của trường hợp sử dụng 1 trong tài liệu cập nhật | Ngày 25 tháng 6 |
| Bản thảo 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 tài liệu cập nhật 2 | Ngày 2 tháng 7 |
| Bản thảo 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 tài liệu cập nhật 3 | Ngày 9 tháng 7 |
| Bản nháp về trường hợp sử dụng 3 do @Dillicious và @KimChiCook xem xét | Ngày 16 tháng 7 |
| Mọi câu hỏi được trả lời cho mọi trường hợp sử dụng | Ngày 30 tháng 7 |
| Hầu hết các thành viên SIG PickleDocs đều nghỉ phép 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 |
| Đã đưa ý kiến phản hồi về thử nghiệm vào | Ngày 10 tháng 9 |
| Biên tậ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 |
| Quy trình cập nhật tài liệu đã tạo | 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 rằng nhà văn kỹ thuật sẽ dành 10 đến 15 giờ mỗi tuần để làm việc trên dự án của chúng tôi. Sam đã ghi lại thời gian và trung bình là 11,5 giờ mỗi tuần.
Kết quả
Điều gì đã được tạo, cập nhật hoặc thay đổi? Đưa vào các đường liên kết đến tài liệu đã xuất bản (nếu có). Có nội dung nào mà đề xuất không tạo ra được không? Hãy liệt kê cả những ứng dụng đó.
Có ba trường hợp sử dụng chính được ghi lại kèm theo hướng dẫn cách sử dụng đầy đủ cho người dùng:
Cách thêm một thành phần mới vào GloriousPickle
Cách thêm một nguyên liệu biến thể vào GloriousPickle
Cách cập nhật hoặc chỉnh sửa một thành phần trong GloriousPickle
Các hướng dẫn này cũng bao gồm các mẫu yêu cầu kéo mới để giúp bạn dễ dàng đóng góp hơn.
Ngoài ra, trong dự án này, Sam đã tạo một Bảng chú giải thuật ngữ nhỏ về các thuật ngữ mà họ học được từ Pickle. Những thuật ngữ này cũng được xuất bản trên trang web của dự án GloriousPickle.
Chúng tôi đã thêm hướng dẫn cập nhật các hướng dẫn sử dụng này vào dự án wiki của chúng tôi.
Chúng tôi đã tạo một bảng tổng quan cho những người mới đóng góp trên 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 hiện có, chúng tôi đã có thể phân nhánh bảng tổng quan của 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 những chỉ số đó không? Các chỉ số có tương quan tốt hay không tốt với kết quả mà bạn muốn đạt được cho dự án? Các chỉ số của bạn có thay đổi kể từ khi bạn đề xuất không?
Trong đề xuất của mình, chúng tôi đã đề xuất hai chỉ số:
- số lượng yêu cầu kéo liên quan đến thành phần
- số lượng yêu cầu lấy dữ liệu từ người đóng góp mới
Trong tháng 9 (cả tháng đầu tiên kể từ khi xuất bản tài liệu bản nháp), chúng tôi nhận thấy số yêu cầu lấy 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 ba người đóng góp mới đưa ra tổng cộng bốn yêu cầu kéo (so với hai người đóng góp mới đã đưa ra hai yêu cầu kéo vào tháng 8). Chúng tôi dự định theo dõi các 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 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 xuất bản.
Có kinh nghiệm, 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 của GloriousPickle — một người đóng góp mới được nhắc đến trong phần bình luận về quảng cáo của họ mà họ từng thử nhưng chưa hoàn tất việc cập nhật vì họ không hiểu quy trình thực hiện.
Phân tích
Điều gì đã diễn ra suôn sẻ? Điều gì không mong muốn? Bạn đã gặp phải những trở ngại hoặc khó khăn gì? Bạn có cho rằng dự án của mình thành công không? Tại sao (hoặc tại sao lại không)? (Nếu còn quá sớm để đánh giá, hãy giải thích thời điểm bạn dự kiế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 Google Season of Docs và coi đây là một dự án thành công. Tài liệu mới rất rõ ràng và hữu ích. Chúng tôi đã nhận thấy 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 các cộng tác viên mới tăng lên đáng kể.
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 ý kiến phản hồi về đề xuất ban đầu và kiểm thử tài liệu mới ở dạng bản nháp.
Chúng tôi đã gặp phải một số trở ngại ngoài dự kiến. Chúng tôi rất cảm ơn vì đám cháy rừng ở tiểu bang của Sam không gây ra thiệt hại nào ngoài việc mất Internet! Ngoài ra, chúng tôi rất tiếc khi @VinegarViv không thể tiếp tục tham gia dự án này. Chúng tôi chúc cô và gia đình cô mọi điều tốt lành và mong sớm gặp lại cô.
Một điều chúng tôi không nhận ra cho đến khi Sam bắt đầu làm việc trên tài liệu là có rất nhiều thuật ngữ và từ viết tắt liên quan đến pickle sẽ không quen thuộc với những người tham gia dự án của chúng tôi mà không có kiến thức về pickle. Tuy nhiên, Sam đã ghi lại danh sách mọi thuật ngữ lạ và xác định các thuật ngữ đó thông qua nghiên cứu của riêng mình cũng như nhờ các thành viên trong cộng đồng giải thích và tham khảo. Từ điển thuật ngữ về Pickle này sẽ giúp ích rất nhiều trong việc thu hút thêm nhiều người tham gia cộng đồng Pickle trong tương lai.
Tóm tắt
Tóm tắt trải nghiệm của bạn về dự án trong 2-4 đoạn văn. Nêu bật những điều bạn đã học được và những việc 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 những dự án khác đang cố gắng giải quyết vấn đề tương tự về tài liệu?
Tóm lại, chúng tôi đã có trải nghiệm tuyệt vời! Chúng tôi đã hoàn thành các sản phẩm tài liệu và các chỉ số của chúng tôi có vẻ như phù hợp với mục tiêu.
Một phần lớn trong thành công của dự án này là sự may mắn mà chúng tôi được làm việc với người viết nội dung kỹ thuật, Sam Scribe. [Tôi không viết phần này – Sam] Mặc dù không có kiến thức về cách lưu trữ hoặc kinh nghiệm sử dụng GitHub, nhưng với tư cách là một nhà văn kỹ thuật giàu kinh nghiệm, Sam đã tự tin tìm hiểu một chủ đề mới, đặt câu hỏi và nghiên cứu. Sam nhanh chóng nắm bắt được không chỉ những công cụ dự án của chúng tôi (chúng tôi sử dụng bảng kanban để theo dõi công việc) mà còn cả những câu đùa hài hước của chúng tôi! Chúng tôi rất vui vì Sam đã bắt được bọ rùa và chúng tôi đã "đóng chai" chúng trong cộng đồng của mình.
Chúng tôi sẽ tư vấn cho các dự án khác:
- Giữ cho đề xuất của bạn nhỏ gọn và dễ quản lý. (Ban đầu, chúng tôi muốn đưa tài liệu về cách sử dụng công cụ ước tính của mình với máy tẩm giấm theo lô công nghiệp vào đề xuất, nhưng chỉ bỏ qua tài liệu này vì một trong những thành viên cộng đồng của chúng tôi tham gia sâu vào việc phát triển máy tẩm giấm nguồn mở sẽ viết luận án tiến sĩ trong chương trình.) Rốt cuộc thì chúng ta đã có quá nhiều việc để làm cho Sam bận rộn!
- Tận dụng 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. Hãy hỏi mọi người trong cộng đồng của bạn về đề xuất. Mặc dù tìm thấy Sam thông qua GitHub của Google Season of Docs, nhưng chúng tôi cảm thấy tự tin khi làm việc với họ vì đã trò chuyện với một số người trong thời gian đăng ký.
- Chào mừng nhà văn kỹ thuật đến với cộng đồng của bạn! Sam cho biết rằng thái độ nhiệt tình của GloriousPicklers giúp cô dễ dàng đặt câu hỏi.
- Giúp người viết nội dung kỹ thuật có được kỹ năng về nguồn mở. Sam chưa từng sử dụng git trước đây, nhưng sau khi xem qua một số hướng dẫn, họ đã nhanh chóng tăng tốc. Ban đầu, Sam lo lắng về lượng ý kiến phản hồi mà họ có thể nhận được từ cộng đồng và cách kết hợp ý kiến phản hồi đó. Tuy nhiên, mô hình "thông qua sơ bộ" của cộng đồng ("thông qua sơ bộ là khi tất cả vấn đề được giải quyết, nhưng không nhất thiết phải được giải quyết") đã giúp Sam tự tin giải quyết các ý kiến phê bình bằng chuyên môn viết kỹ thuật của mình.
Phụ lục
Nếu có tài liệu khác mà bạn muốn liên kết đến (ví dụ: nếu bạn đã tạo một hợp đồng để làm việc với người viết kỹ thuật mà bạn muốn chia sẻ, hoặc các mẫu cho dự án tài liệu của mình, hoặc 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 các tài liệu đó 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 các công cụ hoặc tài nguyên hỗ trợ tài liệu mà bạn đã sử dụng, hoặc là nơi để gửi lời cảm ơn hoặc 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 cảm ơn những người và điều sau đây:
- @Dillicious muốn cảm ơn đối tác của mình và đài phát nhạc hip hop chất lượng thấp
- @KimChiCook muốn cảm ơn 할머니 đã dạy anh cách làm dưa chua
- @Piccalily muốn cảm ơn Chicago Manual of Style Online
- @GherKen muốn cảm ơn 3 đứa con đã được ăn hết những củ dưa mà anh ấy có thể làm
- @VinegarViv muốn cảm ơn những thành viên còn lại trong nhóm đã hỗ trợ cô ấy từ bỏ
- @BBChips muốn cảm ơn món ăn không phải dưa chua ngon nhất hiện có, đó là bánh quy caramel của Tunnock
- @GloriousPicklePat muốn cảm ơn PickleDocs SIG vì đã đảm nhận dự án này
- Sam Scribe muốn cảm ơn toàn thể cộng đồng GloriousPickle, đặc biệt là những người làm dưa chua đã gửi cho họ các lọ đựng thực phẩm đóng hộp trong mùa hè năm 2021 khi thiếu lọ đựng thực phẩm đóng hộp, giúp họ bắt đầu hành trình làm ra nhiều món dưa chua ngon!