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