ระยะปัจจุบัน:
เผยแพร่กรณีศึกษาแล้ว ดูไทม์ไลน์
Season of Docs เป็นโปรแกรมความยั่งยืนที่จัดการโดยสำนักงานโปรแกรมโอเพนซอร์สของ Google เป้าหมายของ Season of Docs มีดังนี้
- ให้การสนับสนุนโปรเจ็กต์โอเพนซอร์สเพื่อแก้ปัญหาของโปรเจ็กต์ด้วยเอกสารประกอบ
- ให้โอกาสผู้เขียนเนื้อหาทางเทคนิคได้มีประสบการณ์เกี่ยวกับโอเพนซอร์ส
- เพิ่มการรับรู้เกี่ยวกับโอเพนซอร์ส เอกสารประกอบ และการเขียนเชิงเทคนิค
- รวบรวมและแชร์ข้อมูลเกี่ยวกับเมตริกที่มีประสิทธิภาพในเอกสารประกอบแบบโอเพนซอร์ส
ดูข้อมูลเพิ่มเติมเกี่ยวกับ Season of Docs ได้ในเว็บไซต์ของโปรแกรม
ภาพรวมโปรแกรมปี 2022
วิธีการทํางานของ Season of Docs
ในซีซันนี้ องค์กรจะสมัครเข้าร่วมได้โดยส่งข้อเสนอโปรเจ็กต์ โปรเจ็กต์นี้ประกอบด้วย
- ข้อมูลเกี่ยวกับองค์กร
- คำอธิบายปัญหาที่โปรเจ็กต์กำลังเผชิญ
- วิธีที่โปรเจ็กต์จะใช้เอกสารประกอบเพื่อช่วยแก้ปัญหา
- วิธีที่โปรเจ็กต์จะวัดประสิทธิภาพของเอกสารประกอบ (เมตริก)
- ลำดับเวลาของงาน
- งบประมาณโปรเจ็กต์
- ข้อมูลเพิ่มเติม เช่น ประสบการณ์ขององค์กรในโปรแกรมที่คล้ายกัน หรือสิ่งอื่นๆ ที่จะทําให้ผู้ดูแลระบบของ Season of Docs เข้าใจโปรเจ็กต์และปัญหา
เมื่อได้รับอนุมัติให้เข้าโปรแกรม องค์กรจะเป็นผู้คัดเลือกและจ้างนักเขียนเนื้อหาทางเทคนิคของตนเองโดยตรง Season of Docs ใช้ Open Collective เพื่อระดมทุนให้องค์กรต่างๆ และองค์กรต่างๆ จะจ่ายเงินให้กับนักเขียนเนื้อหาทางเทคนิคผ่าน Open Collective งบประมาณและการชําระเงินของโปรเจ็กต์มีความโปร่งใส งบประมาณจะรวมอยู่ในข้อเสนอโปรเจ็กต์ขององค์กรที่มีอยู่ในเว็บไซต์ Season of Docs และการชําระเงินจะแสดงในบัญชีกลุ่มเปิดของ Season of Docs
ระบบจะถือว่าองค์กรผ่านโปรแกรมนี้เมื่อส่งรายงานกรณีศึกษา นอกจากนี้ เรายังขอให้องค์กรทำการประเมินรายเดือนตลอดระยะเวลาของโปรแกรมและแบบสํารวจติดตามผลรายไตรมาส 3 ครั้งภายในปีหลังจากจบโปรแกรม
ไฮไลต์ของปี 2022
"หลังจากเผยแพร่เอกสารฉบับใหม่ จำนวนการเข้าชม Casbin และ Casdoor ในแต่ละวันเพิ่มขึ้นเกือบ 2 เท่า และอัตราตีกลับลดลงประมาณ 30%" - Casbin
"ผลลัพธ์ที่น่ายินดีของโปรเจ็กต์นี้คือได้เห็น [ผู้เขียนเนื้อหาทางเทคนิค] เติบโตขึ้นสู่บทบาทผู้นำในชุมชนของเรา ตอนนี้ผู้มีส่วนร่วมทั้ง 2 คนได้เป็นผู้นํากลุ่มทํางานและการประชุมชุมชน รวมถึงมีส่วนร่วมในการออกแบบและการบํารุงรักษาโปรเจ็กต์ของเราด้วย" —moja-global
“[GSoD] ช่วยให้เราได้ผู้เขียนเนื้อหาทางเทคนิคที่มีความสามารถ 2 คน ซึ่งหาได้ยากมากในช่องทางปกติ ผู้เขียนเหล่านี้ยังคงเป็นผู้มีส่วนร่วมใน OS ของ OpenMined และทำงานร่วมกับเราได้อย่างดีเยี่ยม" —OpenMined
"นอกจากนี้ คู่มือฉบับใหม่ยังช่วยให้ผู้เริ่มต้นใช้งานมวลสารวิเคราะห์เชิงคำนวณเข้าใจได้ง่ายขึ้นมาก ตัวอย่างที่แสดงให้เห็นถึงประเด็นนี้คือ เงินทุนสนับสนุนจาก 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 แสดงถึงโปรเจ็กต์โอเพนซอร์สที่หลากหลาย กลุ่มประชากรปี 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 of Docs ด้วย เป้าหมายหลักของโปรแกรมคือการให้การสนับสนุนโปรเจ็กต์ในการแก้ปัญหาเกี่ยวกับเอกสาร