ผู้สนับสนุน WordPress หาผู้สนับสนุนเพื่อปรับปรุง Gutenberg Developer Docs

นักพัฒนา WordPress Milana Cap และ Jonathan Bossenger กำลังเริ่มต้นการระดมทุนเพื่อปรับปรุงเอกสารสำหรับนักพัฒนา Gutenberg บทสนทนาเริ่มต้นขึ้นเมื่อวานนี้เมื่อ Cap ทวีตว่าเอกสารมักถูกมองข้ามไปอย่างไรเมื่อบริษัทจ้างผู้ร่วมให้ข้อมูลแบบเต็มเวลาเพื่อทำงานบน WordPress

“เมื่อชุมชนของคุณไม่สามารถเรียนรู้ซอฟต์แวร์ของคุณได้ แสดงว่าคุณไม่มีผู้สนับสนุน” Cap กล่าว “เอกสารและบทช่วยสอนมีความสำคัญมากสำหรับโครงการซอฟต์แวร์โอเพนซอร์สมากกว่าที่ผู้คนคิด”

ครั้งแรกที่ Cap เริ่มขอเอกสาร Gutenberg อยู่ที่งาน Community Summit ที่ปารีส ปี 2017 เธอพยายามชักจูงให้ชุมชนสนใจเอกสารนี้ตั้งแต่นั้นเป็นต้นมา

“มีหลายช่องโหว่ในเอกสารประกอบของตัวแก้ไขบล็อกสำหรับนักพัฒนา แต่สิ่งที่ชัดเจนที่สุดคือวิธีการเริ่มต้น” Cap กล่าว “จุดเริ่มต้นของเอกสารสำหรับนักพัฒนาไม่ได้กล่าวถึงการเริ่มต้นใช้งาน “มันบอกว่าคุณสามารถทำอะไรกับบล็อกได้เท่านั้น แต่ไม่ใช่ _how_ นักพัฒนารุ่นเยาว์ นักพัฒนา PHP เท่านั้น และใครก็ตามที่มีเอกสารนั้นหมายถึง ไม่ทราบว่าโค้ดของบล็อกมีลักษณะอย่างไร จะวางไว้ที่ใด จะรวมไว้อย่างไร ฯลฯ นับประสาวิธีการสร้างบล็อกแบบกำหนดเองด้วยส่วนประกอบที่กำหนดเองและ การตั้งค่า."

ความท้าทายส่วนหนึ่งของการบันทึกตัวแก้ไขบล็อกคือมันอยู่ระหว่างการพัฒนาอย่างแข็งขัน การปรับปรุงและการปรับแต่งจะถูกผลักดันไปยังปลั๊กอิน Gutenberg อย่างต่อเนื่อง และการติดตามว่าสิ่งใดที่มีอยู่หรือไม่มีอยู่ในปัจจุบันในแกนกลางนั้นไม่ใช่เรื่องง่ายเสมอไป เนื่องจาก WordPress กำลังจะเปิดตัวการค้นหาไดเรกทอรีบล็อก จึงเป็นเวลาที่เหมาะสมในการจัดเอกสารการสร้างบล็อกให้เป็นทางการ

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

Marcus Kazmierczak และทีมผู้จัดทำเอกสารกำลังพยายามสร้างบทแนะนำใหม่ในคู่มือเครื่องมือแก้ไขบล็อกอย่างเป็นทางการ ปัญหา GitHub ที่เน้นไปที่การแก้ไขช่องว่างในเอกสารประกอบของนักพัฒนาซอฟต์แวร์ในปัจจุบัน เป็นที่รวมของการอภิปรายเชิงรุกเกี่ยวกับวิธีที่ดีที่สุดในการเขียนเอกสารใหม่สำหรับผู้ที่ยังใหม่ต่อการบล็อกการพัฒนา

“นี่เป็นการเริ่มต้นที่ดี แต่ก็ยังมีงานอีกมากที่ต้องทำ” แคปกล่าว “เอกสารที่สมบูรณ์เขียนขึ้นโดยผู้ที่รู้และเข้าใจ React และ Gutenberg แต่ถูก 'สาปด้วยความรู้' พวกเขาไม่มีเวลามากพอที่จะทำความเข้าใจว่าคนอื่นไม่รู้มากแค่ไหนและควรเขียนเอกสารรายละเอียดใด พูดตามตรง ฉันไม่คิดว่าพวกเขาควรจะใช้เวลากับเรื่องนั้น เรามีทีมเอกสารและเรายินดีที่จะเข้าร่วม แต่จำเป็นต้องมีสะพานบางประเภท”

ปัญหากับเอกสารสำหรับนักพัฒนา Gutenberg: ไม่เป็นมิตรกับผู้มาใหม่

“'ปัญหา' ที่ฉันเห็นในเอกสารประกอบของตัวแก้ไขบล็อกนั้นแตกต่างจากเอกสาร WordPress อื่น ๆ มันถูกเขียนขึ้นสำหรับนักพัฒนา JavaScript ที่มีประสบการณ์และไม่ได้มุ่งเป้าไปที่ผู้เริ่มต้น” Bossenger กล่าว “ฉันควรชี้ให้เห็นด้วยว่านี่ไม่ใช่สิ่งที่จะเกิดขึ้นกับคนที่รวบรวมเอกสารปัจจุบันไว้ด้วยกัน และฉันซาบซึ้งทุกงานที่พวกเขาทำมาจนถึงตอนนี้ มันแค่ต้องการการตรวจสอบและการปรับแต่งอย่างจริงจังเท่านั้น ”

Bossenger กล่าวว่าในอดีต WordPress ทำให้ง่ายสำหรับทุกคนที่มีความรู้ PHP จำนวนจำกัด ในการสร้างปลั๊กอินหรือธีมอย่างรวดเร็วโดยใช้การกระทำและตัวกรองเบ็ด ง่ายต่อการดูโค้ดและเข้าใจว่าควรทำอย่างไร

“จาวาสคริปต์สมัยใหม่ และโดยเฉพาะ React เป็นหม้อต้มปลาที่แตกต่างกันมาก” Bossenger กล่าว “ต้องใช้ความรู้ในระดับที่ลึกซึ้งยิ่งขึ้นเกี่ยวกับวิธีการทำงานของ React รวมถึงคำศัพท์และแนวปฏิบัติใหม่ๆ JavaScript สมัยใหม่อาจสร้างความสับสนได้มาก โดยเฉพาะอย่างยิ่งหากนี่เป็นครั้งแรกที่คุณเห็นสิ่งต่างๆ เช่น ฟังก์ชันลูกศร หรือคำสั่ง if verbose ที่ละเอียดน้อยกว่า

“หากคุณเคยใช้ JavaScript ใน WordPress ที่ใกล้เคียงที่สุดโดยใช้ jQuery การเปลี่ยนไปใช้การพัฒนา Gutenberg แบบ React ยังคงต้องการการเรียนรู้จากคุณ”

หลังจากเรียนสองหลักสูตรก่อนที่เขาจะสร้างอะไรก็ได้สำหรับบรรณาธิการ หนึ่งหลักสูตรใน React และอีกหนึ่งหลักสูตรใน Gutenberg Bossenger กล่าวว่าคู่มือ Block Editor ปัจจุบันไม่ได้เขียนขึ้นสำหรับนักพัฒนาที่ไม่มีประสบการณ์ใน React และ JavaScript ที่ทันสมัย เขาเชื่อว่าจำเป็นต้องมีการปรับโครงสร้างใหม่เพื่ออธิบายแนวคิดใหม่ ๆ ให้ดีขึ้น และเหมาะสมกับรูปแบบที่ผู้มาใหม่บริโภคได้ง่ายขึ้น เขาเน้นที่คู่มือสำหรับนักพัฒนาปลั๊กอินเป็นตัวอย่างที่บทต่างๆ ทำตามโครงสร้างและใช้คำศัพท์ที่คล้ายกับหนังสือเรียน ค่อยๆ แนะนำให้ผู้อ่านรู้จักกับแนวคิดใหม่

“ฉันจะเถียงว่าเป็นไปได้ทีเดียวสำหรับคนที่ไม่มีปลั๊กอินหรือความรู้ PHP ติดอาวุธด้วยคู่มือเล่มนี้และ Google เพื่อสร้างปลั๊กอินง่ายๆ เพื่อตอบสนองความต้องการเฉพาะของพวกเขาอย่างรวดเร็ว” Bossenger กล่าว “ปัจจุบันคู่มือตัวแก้ไขบล็อกไม่เอื้ออำนวยต่อสิ่งนี้”

Bossenger ไม่ได้อยู่คนเดียวในความเห็นของเขาเกี่ยวกับเอกสารฉบับปัจจุบัน Peter Tasker ที่ Delicious Brains เพิ่งเผยแพร่บทช่วยสอนเกี่ยวกับการสร้างบล็อก Gutenberg แบบกำหนดเอง แม้หลังจากทำงานกับ React เต็มเวลาในปีที่ผ่านมา เขาพบว่าเอกสารตัวแก้ไขบล็อกอย่างเป็นทางการนั้น "มีอยู่ทั่วไป" และแยกวิเคราะห์ได้ยาก

หลังจากที่ Cap แสดงความคิดเห็นเกี่ยวกับบริษัทที่ไม่ได้รับการสนับสนุนงานเต็มเวลาในด้านเอกสาร Bossenger ได้ทดสอบน่านน้ำด้วยทวีตถามว่าทั้งสองบริษัทสามารถระดมทุนเพื่อปรับปรุงเอกสารของ Gutenberg ได้หรือไม่

“เช่นเดียวกับทีมแก้ไขบล็อก (และทีม Make อื่น ๆ ) ทีมเอกสารไม่เพียงพอ” Cap กล่าว “เราไม่สามารถที่จะอุทิศสมาชิกสองสามคนเพื่อเรียนรู้ก่อนแล้วจึงเขียนเอกสารเกี่ยวกับการพัฒนาด้วยตัวแก้ไขบล็อก นี่คือเหตุผลหลักสำหรับทวีตของฉัน คุณจะเห็นผู้มีส่วนร่วมที่ได้รับการสนับสนุนทั่วทั้งคอร์แต่ไม่มีในเอกสารประกอบ และฉันกล้าที่จะบอกว่าทั้งคู่มีความสำคัญเท่าเทียมกัน”

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

“เมื่อเรามีแผนแล้ว เราสามารถคาดการณ์ได้ว่าแต่ละส่วนต้องใช้เวลาเท่าไร” เธอกล่าว “ด้วยแผนนี้ เราจะไปค้นหาสปอนเซอร์ ฉันคิดว่าจะมีตัวเลือกในการบริจาคก่อนหน้านั้น แต่ตอนนี้ยังไม่มีอะไรแน่นอน”

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

Bossenger และ Cap กำลังทำงานในแผนสำหรับเอกสารก่อนที่จะประกาศการระดมทุนของพวกเขา ในระหว่างนี้ ใครก็ตามที่ต้องการมีส่วนร่วมในการปรับปรุงเอกสารการสร้างบล็อกสามารถเข้าร่วมการสนทนา GitHub ได้