รายงานกรณีศึกษาปี 2022

หมายเหตุ: รายงานนี้สรุปข้อมูลจากใบสมัครเข้าร่วมโปรแกรมเดิมและจากกรณีศึกษาขั้นสุดท้ายขององค์กร คุณดูกรณีศึกษาฉบับเต็มได้จากหน้าผลลัพธ์ของ Season of Docs ปี 2022

Season of Docs เป็นโปรแกรมความยั่งยืนที่จัดการโดยสำนักงานโปรแกรมโอเพนซอร์สของ Google เป้าหมายของ Season of Docs มีดังนี้

• ให้การสนับสนุนโปรเจ็กต์โอเพนซอร์สในการแก้ปัญหาของโปรเจ็กต์ด้วยเอกสารประกอบ
• มอบโอกาสให้นักเขียนด้านเทคนิคได้รับประสบการณ์ในโอเพนซอร์ส
• สร้างการรับรู้เกี่ยวกับโอเพนซอร์ส เอกสารประกอบ และการเขียนด้านเทคนิค
• รวบรวมและแชร์ข้อมูลเกี่ยวกับเมตริกที่มีประสิทธิภาพในเอกสารประกอบโอเพนซอร์ส

ดูข้อมูลเพิ่มเติมเกี่ยวกับ Season of Docs ได้ที่เว็บไซต์ของโปรแกรม

ภาพรวมของโปรแกรมปี 2022

วิธีทำงานของ Season of Docs

ใน Season of Docs องค์กรจะสมัครเข้าร่วมโดยส่งข้อเสนอโปรเจ็กต์ ซึ่งข้อเสนอโปรเจ็กต์ประกอบด้วย

• ข้อมูลเกี่ยวกับองค์กร
• คำอธิบายเกี่ยวกับปัญหาที่โปรเจ็กต์กำลังเผชิญ
• วิธีที่โปรเจ็กต์จะใช้เอกสารประกอบเพื่อช่วยแก้ปัญหา
• วิธีที่โปรเจ็กต์จะวัดประสิทธิภาพของเอกสารประกอบ (เมตริก)
• ไทม์ไลน์ของงาน
• งบประมาณของโปรเจ็กต์
• ข้อมูลเพิ่มเติม เช่น ประสบการณ์ขององค์กรในการเข้าร่วมโปรแกรมที่คล้ายกัน หรือข้อมูลอื่นๆ ที่จะช่วยให้ผู้ดูแลระบบของ Season of Docs เข้าใจโปรเจ็กต์และปัญหาขององค์กร

เมื่อได้รับการยอมรับให้เข้าร่วมโปรแกรมแล้ว องค์กรจะรับสมัครและจ้างนักเขียนด้านเทคนิคของตนเองโดยตรง Season of Docs ใช้ Open Collective เพื่อให้เงินทุนแก่องค์กร และองค์กรจะจ่ายเงินให้นักเขียนด้านเทคนิคผ่าน Open Collective งบประมาณและการชำระเงินของโปรเจ็กต์มีความโปร่งใส โดยงบประมาณจะรวมอยู่ในข้อเสนอโปรเจ็กต์ขององค์กรที่พร้อมใช้งานในเว็บไซต์ Season of Docs และการชำระเงินจะแสดงในบัญชี Open Collective ของ Season of Docs

เราจะถือว่าองค์กรเข้าร่วมโปรแกรมเสร็จสมบูรณ์เมื่อส่งรายงานกรณีศึกษา นอกจากนี้ เรายังขอให้องค์กรทำการประเมินรายเดือนระหว่างเข้าร่วมโปรแกรม และตอบแบบสำรวจติดตามผลรายไตรมาส 3 ครั้งในระหว่างปีหลังจากเข้าร่วมโปรแกรมเสร็จสมบูรณ์

ไฮไลต์ปี 2022

"หลังจากเผยแพร่เอกสารใหม่ จำนวนการเข้าชม Casbin และ Casdoor รายวันเพิ่มขึ้นเกือบ 2 เท่า และอัตราตีกลับลดลงประมาณ 30%" - Casbin

"ผลลัพธ์ที่น่ายินดีของโปรเจ็กต์นี้คือการได้เห็น [นักเขียนด้านเทคนิคของเรา] เติบโตขึ้นจนก้าวขึ้นมาเป็นผู้นำในชุมชน ตอนนี้ผู้สนับสนุนทั้ง 2 คนเป็นผู้นำกลุ่มการทำงานและการประชุมชุมชน รวมถึงมีส่วนร่วมในการออกแบบและดูแลโปรเจ็กต์ของเรา" - moja-global

"[GSoD] ช่วยให้เราได้นักเขียนด้านเทคนิคที่มีความสามารถ 2 คน ซึ่งหาได้ยากมากในสถานการณ์ปกติ โดยนักเขียนทั้ง 2 คนยังคงเป็นผู้สนับสนุน OS ที่ใช้งานอยู่ของ OpenMined และเราได้รับประสบการณ์การทำงานที่ยอดเยี่ยมกับนักเขียนทั้ง 2 คน" - OpenMined

"นอกจากนี้ คู่มือใหม่ยังช่วยให้ผู้เริ่มต้นใช้งาน Computational Mass Spectrometry เข้าใจได้ง่ายขึ้นมาก ตัวอย่างเช่น เงินทุนสนับสนุนจาก CZI ยังให้เงินค่าครองชีพแก่บุคคลที่ด้อยโอกาสในอดีต และผู้รับเงินทุนสนับสนุนบางรายได้ใช้คู่มือ OpenMS ใหม่เพื่อเริ่มต้นช่วงฝึกงาน 6 สัปดาห์ และให้ความเห็นเชิงบวกเกี่ยวกับคู่มือใหม่" - OpenMS

ข้อมูลสรุปปี 2022

ในปี 2022 โปรแกรม Season of Docs ยอมรับ 31 โปรเจ็กต์จาก 67 ใบสมัคร และ 30 โปรเจ็กต์เข้าร่วมโปรแกรมเสร็จสมบูรณ์ ใน 31 องค์กรที่ได้รับการยอมรับ มี 17 องค์กรที่เคยสมัครเข้าร่วมโปรแกรมนี้มาก่อน

31 โปรเจ็กต์ที่ได้รับการยอมรับได้จ้างนักเขียนด้านเทคนิค 58 คน นักเขียนด้านเทคนิคมากกว่า 190 คนแสดงความสนใจที่จะเข้าร่วมโปรแกรมโดยเพิ่มข้อมูลติดต่อและลิงก์ไปยังผลงานของตนในที่เก็บ GitHub ของ Season of Docs

สำหรับโปรแกรมปี 2022

• 100% ขององค์กรได้รับประสบการณ์ที่ดีจากกระบวนการสมัคร
• 100% ขององค์กรได้รับประสบการณ์ที่ดีจากเอกสารประกอบ/เนื้อหาในเว็บไซต์ของโปรแกรม
• 93% ขององค์กรได้รับประสบการณ์ที่ดีจากโปรแกรม
• 90% ขององค์กรรู้สึกว่าโปรเจ็กต์เอกสารประกอบของตนประสบความสำเร็จ

เกี่ยวกับองค์กร

องค์กรที่เข้าร่วม Season of Docs ปี 2022 เป็นตัวแทนของโปรเจ็กต์โอเพนซอร์สที่หลากหลาย โดยมีโปรเจ็กต์ดังนี้

• เครื่องมือสำหรับนักพัฒนาซอฟต์แวร์ เช่น AsyncAPI และ SpyderIDE
• ภาษาโปรแกรมและเฟรมเวิร์ก เช่น Julia, LFortran, R, และ p5.js
• โปรเจ็กต์ทางวิทยาศาสตร์ เช่น CERN-HSF และ SymPy
• แอปพลิเคชันสำหรับผู้ใช้ปลายทาง เช่น Mautic, Open Food Facts, Talawa, และ Ushahidi
• โปรเจ็กต์ฮาร์ดแวร์และหุ่นยนต์ เช่น ExpressLRS และ Open-RMF
• โปรเจ็กต์ข้อมูล เช่น GeomScale, GeomStats, OpenMined, และ Weaviate
• โปรเจ็กต์ระบบคลาวด์และโครงสร้างพื้นฐาน เช่น cert-manager, NimbleEdge และ Cilium

เราไม่ได้รวบรวมข้อมูลเมตาเกี่ยวกับโปรเจ็กต์ (เช่น วันที่ก่อตั้ง การกระจายตัวทางภูมิศาสตร์ของผู้สนับสนุน จำนวนผู้สนับสนุน หรือขนาดฐานผู้ใช้)

แต่เราได้ขอให้โปรเจ็กต์ระบุใบอนุญาตโอเพนซอร์สที่ใช้

เกี่ยวกับโปรเจ็กต์เอกสารประกอบ

ปัญหาเกี่ยวกับเอกสารประกอบ

ปัญหาหลักที่องค์กรหวังว่าจะแก้ไขได้ด้วยเอกสารประกอบในโปรแกรมปี 2022 มีดังนี้

โปรดทราบว่าองค์กรสามารถรายงานปัญหาเกี่ยวกับเอกสารประกอบได้หลายปัญหา ดูรายละเอียดเพิ่มเติมได้ที่หน้าผลลัพธ์ของ Season of Docs ปี 2022 ซึ่งมีลิงก์ไปยังข้อเสนอโปรเจ็กต์เดิมและกรณีศึกษาฉบับเต็มของแต่ละองค์กร

ประเภทเอกสารประกอบที่สร้างขึ้น

เอกสารประกอบวิธีการเป็นประเภทเอกสารประกอบที่กล่าวถึงบ่อยที่สุดในกรณีศึกษาปี 2022

เอกสารประกอบประเภทอื่นๆ ที่กล่าวถึงในกรณีศึกษา ได้แก่

• คู่มือเริ่มใช้งานฉบับย่อ
• อภิธานศัพท์
• คำถามที่พบบ่อย
• ฐานข้อมูลความรู้
• คอมโพเนนต์
• เนื้อหาในบล็อก/โซเชียลมีเดีย
• คู่มือสำหรับผู้ดูแล

บางหมวดหมู่เหล่านี้อาจไม่ชัดเจน และโปรเจ็กต์เอกสารประกอบเดียวอาจมีเอกสารประกอบหลายประเภทหรือฟีเจอร์ต่างๆ

ดูรายละเอียดเพิ่มเติมได้ที่หน้าผลลัพธ์ของ Season of Docs ปี 2022 ซึ่งมีลิงก์ไปยังข้อเสนอโปรเจ็กต์เดิมและกรณีศึกษาฉบับเต็มของแต่ละองค์กร

งบประมาณ

คำของบประมาณเฉลี่ยอยู่ที่ $11,679 และค่ามัธยฐานอยู่ที่ $12,150 มี 5 องค์กรที่ขอและได้รับเงินทุนสนับสนุนสูงสุดที่พร้อมให้บริการ ($15,000) และ 3 องค์กรที่ขอเงินทุนสนับสนุนต่ำสุด (ระหว่าง $5,000-$7,000)

เมตริก

โปรเจ็กต์ได้ระบุเมตริกที่ใช้ในการวัดความสำเร็จของโปรเจ็กต์เอกสารประกอบไว้ในกรณีศึกษา

เมตริกที่เสนอหลักๆ มีดังนี้

เมตริกอื่นๆ ที่เสนอ ได้แก่

• คำขอแบบดึง/การมีส่วนร่วมในเอกสารประกอบมากขึ้น
• ความคิดเห็นโดยตรงเกี่ยวกับหน้าเอกสารประกอบมากขึ้น
• เวลาที่ใช้ในหน้าเว็บ
• ปัญหาที่พบ (เป็นตัวบ่งชี้การใช้งาน)
• ผู้เข้าร่วมในฟอรัม
• จำนวนพาร์ทเนอร์/อาสาสมัคร/การผสานรวม
• อัตราตีกลับลดลง
• การรับรู้ในชุมชนเพิ่มขึ้น

เนื่องจากมีระยะเวลาสั้นๆ ระหว่างการสิ้นสุดโปรเจ็กต์การเขียนด้านเทคนิคกับการส่งกรณีศึกษา องค์กรส่วนใหญ่ในกลุ่มปี 2022 จึงไม่สามารถรวบรวมข้อมูลได้เพียงพอในขณะที่ส่งกรณีศึกษาเพื่อพิจารณาว่าเมตริกเริ่มต้นเป็นไปตามที่กำหนดหรือไม่

เมื่อเราได้รับคำตอบสำหรับแบบสำรวจติดตามผลในปี 2023 เราจะอัปเดตรายงานนี้เพื่อเพิ่มข้อมูลเกี่ยวกับโปรเจ็กต์ที่บรรลุเมตริกที่กำหนดหรือแก้ไขเมตริก

ดูรายละเอียดเพิ่มเติมได้ที่หน้าผลลัพธ์ของ Season of Docs ปี 2022 ซึ่งมีลิงก์ไปยังข้อเสนอโปรเจ็กต์เดิมและกรณีศึกษาฉบับเต็มของแต่ละองค์กร

การทำงานร่วมกับนักเขียนด้านเทคนิค

ในโปรแกรม Season of Docs องค์กรจะต้องรับสมัคร สัมภาษณ์ จ้าง และจ่ายเงินให้นักเขียนด้านเทคนิคโดยตรง นักเขียนด้านเทคนิคสามารถเพิ่มตัวเองลงในไดเรกทอรีที่ดูแลโดย Season of Docs ในที่เก็บ GitHub ของเราได้ แต่เจ้าหน้าที่ของ Season of Docs จะไม่ตรวจสอบหรือแนะนำนักเขียนด้านเทคนิค

แนวทางปฏิบัติแนะนำสำหรับการจ้างนักเขียนด้านเทคนิคสำหรับโปรเจ็กต์โอเพนซอร์ส

เราได้ขอให้องค์กรแชร์แนวทางปฏิบัติแนะนำสำหรับการรับสมัคร จ้าง และทำงานร่วมกับนักเขียนด้านเทคนิค คำแนะนำหลักๆ มีดังนี้

การรับสมัคร

• สัมภาษณ์ผู้สมัครจำนวนน้อยลง และใช้เซสชันการฝึกปฏิบัติแบบสดแทนที่จะเพียงแค่ตรวจสอบ CV
• ให้ความสำคัญกับทักษะการสื่อสารด้วยการเขียนและการพูดมากกว่าความเชี่ยวชาญในภาษาหรือเครื่องมือของโปรเจ็กต์
• ถามคำถามโดยตรงเกี่ยวกับวิธีที่นักเขียนด้านเทคนิคจะได้รับความรู้เฉพาะทางที่จำเป็นในการทำงานร่วมกับโปรเจ็กต์ของคุณ
• ผู้ที่มีความกระตือรือร้นในพันธกิจของโปรเจ็กต์และมีค่านิยมหลักแบบเดียวกับโอเพนซอร์สมีแนวโน้มที่จะมีแรงจูงใจตลอดทั้งโปรเจ็กต์
• เปิดรับผู้สมัครจากทั่วโลก เนื่องจากมุมมองและภูมิหลังที่หลากหลายจะช่วยโปรเจ็กต์ของคุณได้ แต่โปรดทราบว่าการมีนักเขียนและผู้ให้คำปรึกษาในเขตเวลาที่ขัดแย้งกันมากเกินไปอาจต้องใช้ความพยายามอย่างมากในการรักษาการสื่อสารที่ดี

การจ้างงาน

• ใช้สัญญาที่ระบุผลลัพธ์ที่ส่งมอบ ตารางเวลาการชำระเงิน และข้อผูกมัดด้านเวลาที่เฉพาะเจาะจงไว้อย่างชัดเจน
• หากโปรเจ็กต์ของคุณมีสิ่งที่ไม่ทราบจำนวนมาก ให้รวมเป้าหมายย่อยสำหรับการค้นพบหรือการวิจัยแยกต่างหากจากการสร้างเอกสารประกอบ

การประสานงานและการสื่อสาร

• เก็บบันทึกการประชุมเพื่อบันทึกการตัดสินใจต่างๆ เพื่อให้ทุกคนที่ทำงานในโปรเจ็กต์เข้าใจบริบทและขั้นตอนถัดไปได้ง่ายขึ้น
• ระบุให้ชัดเจนว่าคาดหวังให้มีการสื่อสารแบบใดและบ่อยเพียงใด ไม่ว่าจะเป็นการโทรรายสัปดาห์ อีเมลรายวัน หรือการอัปเดตสถานะในช่องทางแชท
• ตอบสนองและให้ความคิดเห็นที่ชัดเจนซึ่งรวมถึง "เหตุผล" ไม่ใช่แค่ "สิ่งที่จะทำ"
• เชื่อมต่อนักเขียนด้านเทคนิคของคุณกับชุมชนในวงกว้างเพื่อให้บริบทและเผยแพร่ผลงานของนักเขียน

กระบวนการและเครื่องมือ

• สร้างกระบวนการเอกสารประกอบที่จะคงอยู่ต่อไปหลังจากโปรแกรม Season of Docs สิ้นสุดลง และชุมชนทั้งหมดสามารถมีส่วนร่วมได้
• การตรวจสอบเอกสารประกอบจะใช้เวลาอย่างน้อยเท่ากับการรีวิวโค้ดและต้องใช้ความพยายามมากพอๆ กัน ดังนั้นโปรดจัดสรรเวลาให้เพียงพอ

เราได้แก้ไขและย่อคำแนะนำบางข้อเพื่อให้ชัดเจนยิ่งขึ้น

เช่นเดียวกับโปรแกรมปี 2021 นักเขียนด้านเทคนิคส่วนใหญ่ใน Season of Docs ปี 2022 ได้สมัครเข้าร่วมองค์กรที่ตนทำงานด้วยโดยตรง

ปัญหาที่พบได้ทั่วไปในการทำงานร่วมกับนักเขียนด้านเทคนิค

มีโปรเจ็กต์จำนวนน้อยลงที่รายงานปัญหาในการทำงานร่วมกับนักเขียนด้านเทคนิคในโปรแกรมปี 2022 ปัญหาที่ใหญ่ที่สุดคือ นักเขียนด้านเทคนิคไม่สามารถเข้าร่วมโปรแกรมให้เสร็จสมบูรณ์ได้เนื่องจากป่วย ต้องทำงานเต็มเวลา หรือไม่สามารถทำตามข้อผูกมัดด้านเวลาได้

โปรเจ็กต์หนึ่งรายงานว่าโปรเจ็กต์เอกสารประกอบของตนขึ้นอยู่กับงานที่ทำเป็นส่วนหนึ่งของ Google Summer of Code และการจัดการการพึ่งพาดังกล่าวเป็นเรื่องยาก อีกโปรเจ็กต์หนึ่งพบปัญหาเมื่อฮาร์ดแวร์ที่นักเขียนด้านเทคนิคต้องใช้ในการทำเอกสารประกอบถูกกระทรวงกลาโหมในประเทศของนักเขียนยึด และไม่สามารถนำเข้าได้

แบบสำรวจติดตามผล

เราจะส่งแบบสำรวจติดตามผล 3 ครั้งไปยังผู้เข้าร่วมปี 2022 ในเดือนพฤษภาคม สิงหาคม และพฤศจิกายน 2023 เราจะอัปเดตส่วนนี้ด้วยผลลัพธ์เมื่อได้รับ

คำถามในอนาคต

เช่นเคย ยิ่งเรารู้เกี่ยวกับเอกสารประกอบในโอเพนซอร์สมากเท่าไหร่ เราก็ยิ่งอยากรู้มากขึ้นเท่านั้น

ใน Season ต่อๆ ไป เราหวังว่าจะ

• รวบรวมข้อมูลเมตาของโปรเจ็กต์เพิ่มเติมเพื่อดูความสัมพันธ์ระหว่างอายุของโปรเจ็กต์ ขนาดชุมชน หรือภาษา กับความต้องการเอกสารประกอบ
• วิเคราะห์โปรเจ็กต์เอกสารประกอบเพื่อดูว่าสามารถสรุปเป็นเทมเพลตที่แชร์ได้หรือไม่
• พัฒนาเกณฑ์การให้คะแนนสำหรับการสัมภาษณ์นักเขียนด้านเทคนิคในโปรเจ็กต์โอเพนซอร์ส

แม้ว่าจะมีคำถามมากมายที่เราอยากจะตรวจสอบ แต่เราก็อยากจะเคารพเวลาของผู้ดูแลระบบและผู้ดูแลโปรเจ็กต์โอเพนซอร์สที่เข้าร่วม Season of Docs ด้วย สิ่งสำคัญอันดับแรกของโปรแกรมคือการสนับสนุนโปรเจ็กต์ในการแก้ปัญหาด้วยเอกสารประกอบ