ระยะปัจจุบัน:
การพัฒนาเอกสาร ดูไทม์ไลน์
Season of Docs เป็นโปรแกรมเพื่อความยั่งยืนที่จัดการโดยสำนักงานโปรแกรมโอเพนซอร์สของ Google เป้าหมายของซีซันของเอกสารมีดังนี้
- ให้การสนับสนุนโครงการโอเพนซอร์สเพื่อแก้ไขปัญหาโครงการด้วยเอกสารประกอบ
- ให้โอกาสนักเขียนด้านเทคนิคได้มีประสบการณ์ในโอเพนซอร์ส
- เพิ่มการรับรู้เกี่ยวกับโอเพนซอร์ส เอกสารประกอบ และการเขียนเชิงเทคนิค
- รวบรวมและแชร์ข้อมูลเกี่ยวกับเมตริกที่มีประสิทธิภาพในเอกสารโอเพนซอร์ส
ดูข้อมูลเพิ่มเติมเกี่ยวกับซีซันของเอกสารในเว็บไซต์ของโปรแกรม
ภาพรวมของโปรแกรมปี 2022
วิธีการทำงานของซีซันของเอกสาร
ในฤดูกาลของเอกสาร องค์กรต่างๆ จะสมัครโดยการส่งข้อเสนอโปรเจ็กต์ ข้อเสนอโครงการมีดังนี้
- ข้อมูลเกี่ยวกับองค์กร
- คำอธิบายปัญหาที่โครงการประสบ
- โปรเจ็กต์จะใช้เอกสารประกอบเพื่อช่วยแก้ปัญหาอย่างไร
- วิธีที่โปรเจ็กต์จะวัดประสิทธิภาพของเอกสารประกอบ (เมตริก)
- ลำดับเวลาของงาน
- งบประมาณของโปรเจ็กต์
- ข้อมูลเพิ่มเติม เช่น ประสบการณ์ในการใช้งานโปรแกรมที่คล้ายกันขององค์กร หรือข้อมูลอื่นๆ ที่จะช่วยให้ผู้ดูแลระบบ Season of Docs เข้าใจโปรเจ็กต์และปัญหาของตน
เมื่อได้รับอนุมัติให้เข้าร่วมโปรแกรมแล้ว องค์กรต่างๆ จะสรรหาและจ้างนักเขียนเชิงเทคนิคของตนเองโดยตรง Season of Docs ใช้ Open Collective เพื่อให้ทุนแก่องค์กรต่างๆ และองค์กรต่างๆ จ่ายเงินให้นักเขียนด้านเทคนิคผ่าน Open Collective งบประมาณและการชำระเงินของโปรเจ็กต์มีความโปร่งใส งบประมาณจะรวมอยู่ในข้อเสนอโปรเจ็กต์ขององค์กรในเว็บไซต์ซีซันของเอกสาร และการชำระเงินจะปรากฏในบัญชีซีซันที่เปิดเอกสาร
เมื่อส่งรายงานกรณีศึกษา องค์กรจะได้รับการพิจารณาที่สำเร็จโปรแกรมนี้ นอกจากนี้ยังขอให้องค์กรทำการประเมินรายเดือนระหว่างเข้าร่วมโปรแกรมและทำแบบสำรวจติดตามผลรายไตรมาส 3 ครั้งในระหว่างปีหลังจากที่โปรแกรมสำเร็จ
ไฮไลต์ประจำปี 2022
"หลังจากออกเอกสารฉบับใหม่ การเข้าชม Casbin and Casdoor ในแต่ละวันเพิ่มขึ้นเกือบเท่าตัว และอัตราตีกลับลดลงประมาณ 30%" - Casbin
"ผลลัพธ์ที่น่าพึงพอใจของโปรเจ็กต์นี้คือการเฝ้าดู [นักเขียนด้านเทคนิคของเรา] ก้าวขึ้นมาเป็นผู้นำในชุมชนของเรา ตอนนี้ผู้มีส่วนร่วมทั้ง 2 คนเป็นผู้นำกลุ่มทำงานและการประชุมในชุมชน อีกทั้งยังมีส่วนร่วมในการออกแบบและบำรุงรักษาโปรเจ็กต์ของเราด้วย" -moja-global
"[GSoD] ช่วยเราสรรหานักเขียนด้านเทคนิคที่มีความสามารถ 2 คนซึ่งทำได้ยากในการทำงานทั่วไป ยังคงเป็นผู้สนับสนุนระบบปฏิบัติการที่ OpenMined อยู่อย่างต่อเนื่อง และเราก็มีประสบการณ์การทำงานที่ยอดเยี่ยมด้วย" -OpenMined
"นอกจากนี้ คู่มือใหม่ยังง่ายขึ้นมากสำหรับมือใหม่ในการคํานวณแมสสเปกโตรเมทรี เพื่อแสดงให้เห็นถึงประเด็นนี้: งบประมาณสนับสนุนจาก CZI ยังให้เงินสนับสนุนสำหรับบุคคลด้อยโอกาสในอดีตและผู้ได้รับรางวัลบางคนใช้คู่มือ OpenMS ใหม่เพื่อเริ่มฝึกงาน 6 สัปดาห์อย่างรวดเร็ว และได้รับรีวิวในแง่บวกเกี่ยวกับคู่มือฉบับใหม่" -OpenMS
ข้อมูลสรุปปี 2022
ในปี 2022 โปรแกรม Season of Docs ได้ยอมรับ 31 โปรเจ็กต์จาก 67 โปรเจ็กต์ และ 30 โปรเจ็กต์สำเร็จ จากองค์กรทั้งหมด 31 องค์กรที่ได้รับการยอมรับ มี 17 องค์กรที่เป็นผู้สมัครเข้าร่วมซ้ำ
โครงการที่ยอมรับ 31 โครงการว่าจ้างนักเขียนเชิงเทคนิค 58 คน นักเขียนเชิงเทคนิคกว่า 190 คนระบุว่าสนใจเข้าร่วมโปรแกรมโดยเพิ่มข้อมูลติดต่อและลิงก์ไปยังพอร์ตโฟลิโอในที่เก็บ Season of Docs ของ GitHub
สำหรับโปรแกรมปี 2022:
- 100% ขององค์กรต่างๆ มีประสบการณ์ที่ดีกับขั้นตอนการสมัคร
- 100% ขององค์กรต่างๆ มีประสบการณ์ในเชิงบวกกับเอกสาร/เนื้อหาของเว็บไซต์โปรแกรม
- 93% ขององค์กรต่างๆ มีประสบการณ์ในเชิงบวกกับโปรแกรมนี้
- 90% ขององค์กรรู้สึกว่าโครงการจัดทำเอกสารของตนประสบความสำเร็จ
เกี่ยวกับองค์กร
องค์กรที่เข้าร่วมในฤดูกาลของเอกสาร 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 ได้แก่
โปรดทราบว่าองค์กรอาจรายงานปัญหาเกี่ยวกับเอกสารประกอบหลายรายการ โปรดดูรายละเอียดเพิ่มเติมในหน้าผลการค้นหาฤดูกาลของเอกสาร 2022 ซึ่งจะลิงก์ไปยังข้อเสนอโปรเจ็กต์ต้นฉบับและกรณีศึกษาแบบเต็มของแต่ละองค์กร
ประเภทของเอกสารที่สร้างขึ้น
เอกสารแสดงวิธีการเป็นเอกสารประเภทที่มีการพูดถึงบ่อยที่สุดในกรณีศึกษาปี 2022
เอกสารประเภทอื่นๆ ที่กล่าวถึงในกรณีศึกษามีดังนี้
- คู่มือเริ่มใช้งานฉบับย่อ
- อภิธานศัพท์
- คำถามที่พบบ่อย
- ฐานความรู้
- คอมโพเนนต์
- เนื้อหาบล็อก/โซเชียลมีเดีย
- คำแนะนำผู้บำรุงรักษา
หมวดหมู่เหล่านี้บางส่วนไม่ชัดเจนและโครงการเอกสารโครงการเดียวอาจมีเอกสารหลายประเภทหรือหลายฟีเจอร์
โปรดดูรายละเอียดเพิ่มเติมในหน้าผลการค้นหาฤดูกาลของเอกสาร 2022 ซึ่งจะลิงก์ไปยังข้อเสนอโปรเจ็กต์ต้นฉบับและกรณีศึกษาแบบเต็มของแต่ละองค์กร
งบประมาณ
คำของบประมาณเฉลี่ยคือ $11,679 และค่ามัธยฐานคือ $12,150 5 องค์กรร้องขอและได้รับเงินทุนสูงสุด ($15,000) และ 3 องค์กรที่ของบประมาณต่ำสุด (ระหว่าง $5,000-$7,000)
เมตริก
โครงการที่ระบุไว้ในกรณีศึกษา คือ เมตริกที่ใช้วัดความสำเร็จของโครงการจัดทำเอกสาร
เมตริกที่เสนอมากที่สุดคือ
เมตริกอื่นๆ ที่เสนอ ได้แก่
- คำขอ/การมีส่วนร่วมในการดึงเอกสารเพิ่มเติม
- ความคิดเห็นโดยตรงเพิ่มเติมเกี่ยวกับหน้าเอกสาร
- เวลาที่ใช้ในหน้าเว็บ
- ปัญหาที่พบ (เป็นพร็อกซีสำหรับการใช้งาน)
- ผู้เข้าร่วมในฟอรัม
- จำนวนพาร์ทเนอร์/อาสาสมัคร/การผสานรวม
- อัตราตีกลับลดลง
- เพิ่มการรับรู้ในชุมชน
เนื่องจากระยะเวลาสั้นๆ ระหว่างที่ทำโปรเจ็กต์งานเขียนเชิงเทคนิคจนเสร็จกับการส่งกรณีศึกษา กลุ่มประชากรตามรุ่นส่วนใหญ่ในปี 2022 จึงรวบรวมข้อมูลได้ไม่มากพอ ณ เวลาที่ส่งกรณีศึกษา ในการพิจารณาว่าเมตริกเริ่มต้นเป็นไปตามหลักเกณฑ์หรือไม่
เมื่อได้รับคําตอบในแบบสํารวจติดตามผลในปี 2023 เราจะอัปเดตรายงานนี้เพื่อเพิ่มข้อมูลเกี่ยวกับโปรเจ็กต์ที่บรรลุเมตริกแล้วหรือแก้ไขเมตริก
โปรดดูรายละเอียดเพิ่มเติมในหน้าผลการค้นหาฤดูกาลของเอกสาร 2022 ซึ่งจะลิงก์ไปยังข้อเสนอโปรเจ็กต์ต้นฉบับและกรณีศึกษาแบบเต็มของแต่ละองค์กร
ทำงานร่วมกับนักเขียนเชิงเทคนิค
ในโปรแกรม Season of Docs โครงการต่างๆ คาดหวังว่าจะสรรหา สัมภาษณ์ จ้าง และจ่ายเงินให้กับนักเขียนด้านเทคนิคโดยตรง นักเขียนเชิงเทคนิคสามารถเพิ่มตนเองในไดเรกทอรีที่ดูแลโดย Season of Docs ได้ในที่เก็บของ GitHub แต่เจ้าหน้าที่ Season of Docs ไม่ได้ทำการตรวจสอบหรือแนะนำนักเขียนด้านเทคนิค
แนวทางปฏิบัติแนะนำในการจ้างผู้เขียนด้านเทคนิคสำหรับโปรเจ็กต์โอเพนซอร์ส
มีการขอให้โปรเจ็กต์แชร์แนวทางปฏิบัติแนะนำในการสรรหา การจ้างงาน และการทำงานร่วมกับนักเขียนเชิงเทคนิค คำแนะนำหลักๆ มีดังนี้
การรับเข้าทำงาน
- สัมภาษณ์ผู้สมัครน้อยลงและใช้เซสชันการฝึกปฏิบัติแบบสดแทนการตรวจสอบ CV เพียงอย่างเดียว
- ให้คุณค่าทักษะการสื่อสารทั้งการเขียนและปาก มากกว่าความเชี่ยวชาญด้านภาษาหรือเครื่องมือของโปรเจ็กต์
- ถามคำถามโดยตรงเกี่ยวกับวิธีที่นักเขียนด้านเทคนิคจะได้รับความรู้ด้านโดเมนที่จำเป็นในการทำงานโครงการของคุณ
- ผู้ที่มีความสนใจต่อพันธกิจของโปรเจ็กต์ของคุณและผู้ที่แชร์ค่านิยมหลักเกี่ยวกับโอเพนซอร์สมีแนวโน้มที่จะได้รับแรงจูงใจตลอดทั้งโปรเจ็กต์
- เปิดรับผู้สมัครจากทั่วทุกมุมโลก เนื่องจากความคิดเห็นและภูมิหลังที่หลากหลายจะช่วยสนับสนุนโครงการของคุณ แต่โปรดทราบว่าการมีนักเขียนและที่ปรึกษาในเขตเวลาที่ขัดแย้งมากเกินไปอาจต้องใช้ความพยายามอย่างมากในการสื่อสารที่ดี
จำนวนที่รับ
- ใช้สัญญาที่ระบุสิ่งที่ส่งมอบ กำหนดการชำระเงิน และกำหนดเวลาที่เจาะจงไว้อย่างชัดเจน
- หากโปรเจ็กต์ของคุณมีข้อมูลที่ไม่รู้จักจำนวนมาก ให้ระบุเหตุการณ์สำคัญในการค้นพบหรือการวิจัยแยกจากการสร้างเอกสาร
การประสานงานและการสื่อสาร
- เก็บบันทึกการตัดสินใจในการบันทึกการประชุมเพื่อให้ทุกคนที่ทำงานในโปรเจ็กต์เข้าใจบริบทและขั้นตอนถัดไปได้ง่ายขึ้น
- ระบุให้ชัดเจนถึงการสื่อสารที่คาดหวังและความถี่ในการสื่อสาร ไม่ว่าจะเป็นการโทรรายสัปดาห์ อีเมลรายวัน หรือการอัปเดตสถานะในช่องทางแชท
- ตอบสนองอย่างรวดเร็วและให้ความคิดเห็นที่ชัดเจนพร้อมเหตุผลว่า "ทำไม" ไม่ใช่เพียงแค่ "อะไร"
- เชื่อมโยงนักเขียนเชิงเทคนิคเข้ากับชุมชนในวงกว้างเพื่อให้บริบทและพูดคุยแลกเปลี่ยนผลงานกัน
กระบวนการและเครื่องมือ
- สร้างกระบวนการจัดทำเอกสารที่ใช้ได้นอกเหนือจากโปรแกรมซีซันของเอกสาร และทั้งชุมชนสามารถมีส่วนร่วมได้
- การตรวจสอบเอกสารประกอบจะใช้เวลาอย่างน้อย และเข้มงวดพอๆ กับการตรวจสอบโค้ด โปรดตรวจสอบว่าคุณเผื่อเวลาไว้มากพอ
เราได้แก้ไขและย่อคําแนะนําบางรายการเพื่อความชัดเจน
โปรแกรมปี 2021 นักเขียนด้านเทคนิคส่วนใหญ่ในซีซันของเอกสาร 2022 สมัครเข้าร่วมองค์กรที่ตนทำงานด้วยโดยตรง
ปัญหาที่พบบ่อยในการทำงานร่วมกับนักเขียนเชิงเทคนิค
มีโปรเจ็กต์ที่มีการรายงานปัญหาการทำงานร่วมกับนักเขียนด้านเทคนิคในโปรแกรมปี 2022 น้อยลง ปัญหาที่ใหญ่ที่สุด เช่น ความเจ็บป่วย การทำงานประจำ หรือไม่สามารถทำตามกำหนดเวลาได้ ปัญหาหลักคือนักเขียนที่มีประเด็นทางเทคนิคที่ไม่สามารถเรียนจนจบโปรแกรม
โครงการหนึ่งรายงานว่าโครงการจัดทำเอกสารต้องอาศัยงานที่ทำโดยเป็นส่วนหนึ่งของ Google Summer of Code ทำให้ทรัพยากร Dependency เหล่านั้นจัดการได้ยาก โครงการอื่นประสบความยุ่งยากเมื่อทางกระทรวงกลาโหมในประเทศของผู้เขียนยึดฮาร์ดแวร์ที่นักเขียนต้องใช้ในการจัดทำเอกสาร และไม่สามารถนำเข้าได้
แบบสำรวจติดตามผล
เราจะส่งแบบสำรวจติดตามผลจำนวน 3 รายการให้แก่ผู้เข้าร่วมปี 2022 ในเดือนพฤษภาคม สิงหาคม และพฤศจิกายน 2023 เราจะอัปเดตส่วนนี้ด้วยผลลัพธ์ที่ได้รับ
คำถามในอนาคต
และเช่นเคย ยิ่งเราเรียนรู้เกี่ยวกับเอกสารประกอบในโอเพนซอร์สมากเท่าไร เราก็ยิ่งต้องการเรียนรู้มากขึ้นเท่านั้น
ในฤดูกาลในอนาคต เราหวังที่จะ:
- รวบรวมข้อมูลเมตาของโปรเจ็กต์เพิ่มเติมเพื่อดูความสัมพันธ์ระหว่างอายุของโปรเจ็กต์ ขนาดชุมชน หรือความต้องการด้านภาษาและเอกสาร
- วิเคราะห์โปรเจ็กต์เอกสารประกอบเพื่อดูว่าสามารถนำมาปรับใช้เป็นเทมเพลตที่แชร์ได้ทั่วไปหรือไม่
- พัฒนาเกณฑ์การให้คะแนนสำหรับสัมภาษณ์นักเขียนเชิงเทคนิคในโปรเจ็กต์โอเพนซอร์ส
แม้ว่าจะมีคำถามที่เราต้องการตรวจสอบจำนวนมาก แต่เราก็ต้องเคารพเวลาของผู้ดูแลระบบโครงการโอเพนซอร์ส และผู้ดูแลรักษาที่มีส่วนร่วมใน Season of Docs สิ่งสำคัญที่สุดของโปรแกรมคือสนับสนุนโครงการต่างๆ ในการแก้ปัญหาโดยใช้เอกสาร