โครงการโอเพ่นซอร์สจะประสบความสำเร็จได้อย่างไรหากไม่มีเอกสารเกี่ยวกับการออกแบบหรือสถาปัตยกรรม

ฉันต้องการพัฒนาทักษะการเขียนโปรแกรมของฉันโดยการศึกษาโครงการโอเพ่นซอร์สที่มีชื่อเสียง แต่ฉันคิดว่ามันง่ายที่จะหลงทางโดยเพียงแค่กระโดดลงไปในซอร์สโค้ดของพวกเขา

ดังนั้นฉันจึงตัดสินใจที่จะอ่านเอกสารเกี่ยวกับการออกแบบหรือสถาปัตยกรรมของพวกเขา (เช่นแผนภาพ UML) เพื่อให้ได้แนวคิดทั่วไปเกี่ยวกับการจัดระเบียบโค้ดของพวกเขาก่อน ฉันประหลาดใจ แต่ฉันไม่สามารถหาเอกสารทางสถาปัตยกรรมสำหรับโครงการโอเพ่นซอร์สขนาดใหญ่เช่น Hibernate, Spring, ASP.NET MVC, Rails และอื่น ๆ

ดังนั้นฉันจึงเริ่มสงสัยว่า: โครงการโอเพ่นซอร์สจะประสบความสำเร็จได้อย่างไรหากนักพัฒนาผู้มาใหม่ไม่มีเอกสารทางสถาปัตยกรรม / การออกแบบที่จะอ่านหรือถ้าผู้จัดการโครงการเพิ่งเปิดซอร์สโค้ด แต่ปิดเอกสาร?

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

การสันนิษฐานนั้นทำให้คุณรู้ว่าคุณกำลังทำอะไรอยู่และมีความเข้าใจอย่างใกล้ชิดพอสมควรว่าคุณกำลังทำอะไร (และคาดหวัง) ที่จะเห็น

หากคุณมองเข้าไปในโค้ด PHP ของเฟรมเวิร์ก Symfony คุณคาดว่าจะทราบเกี่ยวกับการฉีดพึ่งพาเหตุการณ์รูปแบบโมเดล / มุมมอง / คอนโทรลเลอร์และอื่น ๆ

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

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

กล่าวโดยย่อหากคุณขาดทักษะใด ๆ ที่ผู้ดูแลคาดว่าคุณจะรู้ตามเวลาที่คุณมองเข้าไปในรหัสของพวกเขาคุณอาจขุดสิ่งที่อยู่เหนือระดับการจ่ายของคุณ ทำความคุ้นเคยกับแนวคิดก่อน - รูปแบบ MVC คืออะไร การฉีดพึ่งพาคืออะไร? เป็นต้นดำน้ำแล้ว

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

เนื่องจากผู้พัฒนาโอเพ่นซอร์สมักจะมีความสามารถและเลือกโครงการในสาขาความเชี่ยวชาญของพวกเขาพวกเขาจึงมี "เอกสาร" ภายในกะโหลกของพวกเขา ด้วยเอกสารที่ละเอียดเกินจริงเล็กน้อยเป็นสิ่งจำเป็นเฉพาะเมื่อคุณขาดสิ่งเหล่านี้: o)

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

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

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

โดยทั่วไปการเขียนเอกสารไม่สนุก และถ้าพวกเขาไม่ได้รับเงินใครอยากจะใช้เวลาว่างทำอะไรที่สนุกดี