หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- CircuitVerse
- ผู้เขียนด้านเทคนิค:
- DVL
- ชื่อโปรเจ็กต์:
- การรวมและปรับปรุงหนังสือแบบอินเทอร์แอกทีฟผ่าน CircuitVerse
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
บทคัดย่อ 1 ภาพ
CircuitVerse เป็นโปรเจ็กต์โอเพนซอร์สที่มีเป้าหมายที่จะให้บริการแพลตฟอร์มที่สามารถออกแบบและจำลองวงจรโดยใช้อินเทอร์เฟซผู้ใช้แบบกราฟิกบนเว็บ เครื่องมือจำลองตรรกะใช้เพื่อออกแบบเพื่อการใช้งาน CPU ให้เสร็จสมบูรณ์ได้ แม้ว่าจะออกแบบมาสำหรับการใช้งานในด้านการศึกษาเป็นหลักก็ตาม นอกเหนือจากเอกสารประกอบทางเทคนิคสำหรับซอฟต์แวร์แล้ว หนังสือแบบอินเทอร์แอกทีฟออนไลน์ยังแนะแนวทางให้ผู้ใช้เรียนรู้การออกแบบตรรกะดิจิทัลด้วย หนังสือเล่มนี้ให้ผู้ใช้ลองใช้วงจรต่างๆ จากภายในหนังสือได้โดยตรงเพื่อประสบการณ์แบบอินเทอร์แอกทีฟ
หนังสืออยู่ในช่วงเริ่มต้นของการพัฒนาและตอนนี้ยังขาดบางส่วนที่เกี่ยวข้อง โครงสร้างทั่วไปมีความหลวมในด้านของความต่อเนื่องที่เชื่อมต่อหัวข้อต่างๆ และต้องใช้เนื้อหาที่ละเอียดยิ่งขึ้น นอกจากนี้ ทางองค์กรไม่ได้กำหนดหลักเกณฑ์ที่จะช่วยให้ผู้มีส่วนร่วมทำงานร่วมกันในโปรเจ็กต์ และไม่ได้วางแผนหรือแผนงานเพื่อเป็นแนวทางให้เงินสนับสนุนเนื้อหาที่จำเป็นและลำดับความสำคัญใด
เป้าหมายของข้อเสนอนี้คือการร่วมมือกับ Mentor เพื่อสร้างหลักเกณฑ์การสนับสนุน จัดทำแผนพัฒนาหัวข้อ และช่วยปรับปรุงเนื้อหาปัจจุบัน รวมถึงสร้างเนื้อหาใหม่ตามแผนการพัฒนา
2 สถานะปัจจุบันของหนังสืออินเทอร์แอกทีฟ
นับตั้งแต่เริ่มต้นโปรเจ็กต์ใน Summer of Code 2019 ของโปรเจ็กต์ โปรเจ็กต์ก็ได้แสดงให้เห็น "การเติบโตที่ไม่มีการจัดการ" ด้วยความช่วยเหลือจากชุมชนนักเรียน ตัวองค์กรเองของโปรเจ็กต์ส่วนใหญ่นั้นพัฒนามาจากนักพัฒนาซอฟต์แวร์ นักพัฒนาซอฟต์แวร์จึงได้เข้าร่วม GSoD เพื่อหาความช่วยเหลือจากภายนอกเพื่อปรับปรุงหนังสือแบบอินเทอร์แอกทีฟ นักพัฒนาแอปของโครงการระบุว่าหนังสือเล่มนี้จำเป็นต้องมีการเขียนบางส่วนใหม่ เพิ่มเนื้อหาใหม่ๆ รวมถึงทำให้มีรายละเอียดและครอบคลุมมากขึ้นในปัจจุบัน นอกจากนี้ ทีมยังคาดหวังว่าจะมีหลักเกณฑ์สำหรับการมีส่วนร่วมใหม่ รวมถึง "แผนหลัก" ทั่วไปสำหรับการพัฒนาเนื้อหาหลังจาก GSoD
3 ประโยชน์ของข้อเสนอนี้
ข้อเสนอนี้จะมีส่วนช่วยในการสร้างหลักเกณฑ์การมีส่วนร่วมเวอร์ชันแรกร่วมกัน โดยมีจุดมุ่งหมายเพื่อให้ผู้มีส่วนร่วมดำเนินการร่วมกันได้อย่างลงตัวมากขึ้น ซึ่งจะทำให้เนื้อหามีความสอดคล้องกันมากขึ้น พร้อมระบุแผนการพัฒนาสำหรับหัวข้อของหนังสือด้วย นอกจากนี้จะมีส่วนเพิ่มและเปลี่ยนแปลงอย่างเร่งด่วนตามแผนการพัฒนาใหม่ด้วย
4 การวิเคราะห์ตัวเลือกอื่นที่ใช้ได้
โครงการโอเพนซอร์สที่สมบูรณ์และมีลักษณะคล้ายกันหลายโครงการได้พัฒนาหลักเกณฑ์การมีส่วนร่วมสำหรับเอกสารประกอบแล้ว เช่น Wikibooks ([ความช่วยเหลือ:การมีส่วนร่วม], [Wikibooks:นโยบายและหลักเกณฑ์]), OpenStreetMap ([หลักเกณฑ์การแก้ไขขององค์กร]) หรือโครงการเอกสารประกอบของ Linux ([คู่มือผู้แต่ง LDP]) ตัวอย่างเหล่านี้ใช้สร้างหลักเกณฑ์ของโปรเจ็กต์โดยอิงตามประสบการณ์จากโปรเจ็กต์โอเพนซอร์สที่ประสบความสำเร็จได้
สำหรับแผนการพัฒนาของหัวข้อนี้ คุณสามารถเปรียบเทียบประมวลรายวิชาของหลักสูตรแบบเปิด (เช่น [MIT Open Courseware]) รวมถึงหนังสืออ้างอิงเกี่ยวกับวงจรตรรกะดิจิทัล รวมทั้งหนังสือเปิด เช่น [Lessons In Electric Circuits -- Volume IV -Digital], [Wikibooks: Digital Circuits] และ [Wiki] Wikibooks: Digital Electronics Circuits และ [Wiki]
[ความช่วยเหลือ:การให้ข้อมูล] https://en.wikibooks.org/wiki/Help:Contributing
[Wikibooks:นโยบายและหลักเกณฑ์] https://en.wikibooks.org/wiki/Wikibooks:Policies_and_guidelines
[หลักเกณฑ์การแก้ไขขององค์กร] https://wiki.osmfoundation.org/wiki/Organised_Editing_Guidelines
[คู่มือผู้แต่ง LDP] https://www.tldp.org/LDP/LDP-Author-Guide/html/index.html
[MIT เปิด Courseware] https://ocw.mit.edu/
[บทเรียนในวงจรไฟฟ้า -- ระดับเสียงที่ 4 - ดิจิทัล] https://www.ibiblio.org/kuphaldt/electricCircuits/Digital/index.html
[Wikibooks: วงจรดิจิทัล] https://en.wikibooks.org/wiki/Digital_Circuits
[Wikibooks: ดิจิทัลอิเล็กทรอนิกส์] https://en.wikibooks.org/wiki/Digital_Electronics
5 โครงสร้างของเอกสารที่เสนอ
หนังสือแบบอินเทอร์แอกทีฟนี้น่าจะมีประโยชน์สำหรับผู้ชมในวงกว้าง ตั้งแต่มือสมัครเล่นที่เป็นงานอดิเรกแนวอิเล็กทรอนิกส์ นักเรียนศึกษาระดับมัธยมปลาย ไปจนถึงนักเรียนและมืออาชีพในการศึกษาระดับอุดมศึกษาที่ต้องการทบทวนหรือเสริมสร้างทักษะในวงจรตรรกะดิจิทัล
เราได้เสนอโครงสร้างแบบ "หลายเลเยอร์" โดยแต่ละชั้นจะสอดคล้องกับระดับความซับซ้อนที่เพิ่มขึ้นและความลึกทางทฤษฎีของเนื้อหา เพื่อรับมือกับความหลากหลายในผู้ใช้หนังสือ
ดังนั้น โครงสร้างของเอกสารจึงมีการเติบโตเป็น 2 มิติ โดยมิติข้อมูลแรกสอดคล้องกับลำดับหัวข้อเชิงตรรกะหรือแบบเดิมในระบบตรรกะดิจิทัล ส่วนมิติข้อมูลที่ 2 แสดงถึงระดับ
ในรายการที่มีโครงสร้างต่อไปนี้จะแสดงโครงสร้าง 2 มิติที่เสนอไว้ ลำดับหัวข้อมาตรฐานจะแสดงในระดับสูงสุด อธิบายง่ายๆ ในแต่ละหัวข้อจะมีการกำหนดความซับซ้อนเพียง 3 ระดับโดยสัมพันธ์กับระดับพื้นฐาน ปานกลาง และขั้นสูง ในแต่ละระดับจะมีรายการเนื้อหาที่เกี่ยวข้องกับหัวข้อทั่วไปนั้นๆ
- การแสดงแทนโดยใช้เลขไบนารี:
- ระดับพื้นฐาน: จำนวนไบนารี จำนวนลบ ฐานอื่นๆ การเข้ารหัส
- ระดับปานกลาง: [ไม่มีเนื้อหาที่เฉพาะเจาะจง]
- ขั้นสูง: โมดูลและแหวน
- การดำเนินการทางคณิตศาสตร์ที่มีเลขฐานสอง
- ระดับพื้นฐาน: การบวก การลบ การคูณ การหาร
- ระดับกลาง: พีชคณิตบูลีน ฟังก์ชันบูลีน
- ระดับสูง: พีชคณิตอื่นๆ, การแยกองค์ประกอบแบบแชนนอน
- คอมโพเนนต์ SSI แบบผสม
- ระดับพื้นฐาน: สัญลักษณ์ ลอจิกเกต ตารางความจริง
- ระดับกลาง: กลุ่มตรรกะ, Universal gate
- ระดับสูง: พฤติกรรมด้านเวลา (โมเดลการจับเวลา อันตราย)
- การออกแบบตรรกะแบบผสม
- ระดับพื้นฐาน: คำอธิบายฟังก์ชัน การนำไปใช้งาน
- ระดับกลาง: ฟังก์ชัน Canonical, k-Maps
- ขั้นสูง: ตัวแปรที่ป้อนด้วยแผนที่, Quine McCluskey, การแสดงลูกบาศก์แบบไบนารี
- คอมโพเนนต์ของ MSI แบบผสม
- ระดับพื้นฐาน: MUX, DEMUX, โปรแกรมเปลี่ยนไฟล์, ตัวถอดรหัส, Half Adder, Full Adder
- ระดับกลาง: ฟังก์ชันที่ใช้ MUX
- ระดับขั้นสูง: [ไม่มีเนื้อหาที่เจาะจง]
- คอมโพเนนต์ LSI แบบผสม
- ระดับพื้นฐาน: ROM, ALU
- ระดับกลาง: PLD (PLA, PAL, GAL)
- ระดับขั้นสูง: [ไม่มีเนื้อหาที่เจาะจง]
- คอมโพเนนต์ SSI ตามลำดับ
- ระดับพื้นฐาน: สลัก รองเท้าแตะ สัญญาณนาฬิกา แผนภาพเวลา
- ระดับกลาง: การตอบสนองหน่วยความจำ ระบบซิงโครนัส ระบบอะซิงโครนัส
- ระดับขั้นสูง: [ไม่มีเนื้อหาที่เจาะจง]
- คอมโพเนนต์ของ MSI ตามลำดับ
- ระดับพื้นฐาน: การลงทะเบียน ตัวนับ
- ระดับปานกลาง: [ไม่มีเนื้อหาที่เฉพาะเจาะจง]
- ระดับขั้นสูง: [ไม่มีเนื้อหาที่เจาะจง]
การออกแบบตามลำดับ:
- ระดับพื้นฐาน: [ไม่มีเนื้อหาที่เจาะจง]
- ระดับกลาง: การสังเคราะห์ตามลำดับ, FSM (Mealy, Moore), แผนภาพสถานะ, การลดรูปของรัฐ, การกำหนดรัฐ, เงื่อนไขเชื้อชาติ
- ระดับสูง: การออกแบบโดยใช้ MSI, การออกแบบโดยใช้ LSI, แผนภาพกระบวนการ, แผนภาพ MDS
ระดับพื้นฐานควรช่วยให้ผู้ใช้เข้าใจวิธีการทำงานของวงจรตรรกะดิจิทัลและวิธีใช้ โดยไม่ต้องใช้ความรู้คณิตศาสตร์ระดับสูงกว่า ดังนั้นจึงอาจเหมาะสำหรับมือสมัครเล่นที่เป็นงานอดิเรก และนักเรียนในระดับชั้นมัธยมศึกษา หากผู้ใช้เหล่านี้มีทักษะที่จำเป็นและต้องการสร้างความเข้าใจที่ลึกซึ้งยิ่งขึ้น ก็สามารถใช้เนื้อหาระดับปานกลางบางส่วนหรือทั้งหมดก็ได้
ระดับกลางควรมีเนื้อหาและข้อกำหนดเทียบเท่าหลักสูตรแนะนำระดับอุดมศึกษาในระบบตรรกะดิจิทัล
สุดท้าย ระดับสูงประกอบด้วยเนื้อหาที่มักจะพบได้ในหลักสูตรขั้นสูงหรือหลักสูตรเสริมของระบบดิจิทัลในมหาวิทยาลัย
เราจะหารือเกี่ยวกับโครงสร้างที่นำเสนอนี้กับผู้ให้คำปรึกษาในช่วงต้นของโปรเจ็กต์ (สัปดาห์ที่ 3) ซึ่งจะใช้เป็นข้อมูลสำหรับร่างแผนพัฒนาหัวข้อในระยะยาว
โครงสร้างที่เสนอใช้ประโยชน์จากเนื้อหาปัจจุบันของเอกสารส่วนใหญ่หรือทั้งหมด ซึ่งจะได้รับการแก้ไขและขยายหรือแก้ไขตามความเหมาะสม นอกจากนี้ จะมีการเขียนหัวข้อใหม่สำหรับเนื้อหาที่ยังไม่มีในเอกสารประกอบ
6 เป้าหมาย
- สร้างหลักเกณฑ์การมีส่วนร่วมฉบับร่างฉบับแรกสำหรับโปรเจ็กต์หนังสือแบบอินเทอร์แอกทีฟ
- ร่างพัฒนาการสำหรับหัวข้อของหนังสือ
- เขียนใหม่และจัดโครงสร้างเนื้อหาปัจจุบันใหม่
- สร้างเนื้อหาใหม่ตามแผนการพัฒนา
7 ลำดับเวลา
สัปดาห์ที่ 1: (14 ก.ย. - 20 ก.ย.) วิเคราะห์และอภิปรายกับที่ปรึกษาเกี่ยวกับหลักเกณฑ์ที่ดีที่สุดตามตัวอย่างของโครงการอื่น รวมทั้งประสบการณ์ที่ได้รับในปัจจุบันของโครงการ สัปดาห์ที่ 2: (21 ก.ย. - 27 ก.ย.) เขียนหลักเกณฑ์ฉบับร่าง สัปดาห์ที่ 3: (28 ก.ย. - 4 ต.ค.) พูดคุยเรื่องร่างแผนพัฒนาหัวข้อกับที่ปรึกษา สัปดาห์ที่ 4: (5 ต.ค. - 11 ต.ค.) เขียนแผนการพัฒนา สัปดาห์ที่ 5-11: (12 ต.ค. - 29 พ.ย.) เขียนข้อมูลการมีส่วนร่วมซึ่งประกอบด้วยเนื้อหาที่ปรับโครงสร้างและหัวข้อใหม่ สัปดาห์ที่ 12: (30 พ.ย. - 5 ธ.ค.) การส่งรายงานโครงการ การประเมินโปรเจ็กต์: (3 ธ.ค. - 10 ธ.ค.) - การส่งการประเมินโดยผู้เขียนด้านเทคนิค - การส่งการประเมินของที่ปรึกษา
8 ทำไมต้องเป็นหนังสือแบบอินเทอร์แอกทีฟของ CircuitVerse
ฉันเริ่มมองหาแหล่งข้อมูลออนไลน์ที่จะช่วยนักเรียนในหลักสูตรปริญญาตรีเกี่ยวกับระบบตรรกะดิจิทัล เนื่องด้วยวิกฤตโควิด-19 ที่เกิดขึ้นทั่วโลก ฉันสนับสนุนเทคโนโลยีโอเพนซอร์ส Free-Libre มาหลายสิบปีแล้ว ฉันเลยให้ความสำคัญกับโปรเจ็กต์ประเภทนี้มากกว่า ฉันพบเครื่องจำลอง CircuitVerse และพบว่าเป็นเครื่องมือที่ยอดเยี่ยมในการช่วยเสริมกิจกรรมที่ไม่มีในห้องปฏิบัติการเนื่องจากมาตรการควบคุมโควิด-19 ของมหาวิทยาลัย ขณะทดสอบเครื่องจำลอง ผมยังพบหนังสือแบบอินเทอร์แอกทีฟของเขาด้วย และแม้ว่าเนื้อหาจะยังไม่เพียงพอเนื่องจากเป็นข้อมูลอ้างอิงหลักสำหรับหลักสูตรระบบตรรกะดิจิทัลโดยสมบูรณ์ เนื้อหาปัจจุบันก็ถูกต้องและเข้าใจง่าย เราจึงใส่ไว้ในแหล่งข้อมูลการเรียนรู้
เนื่องจากฉันใช้เครื่องจำลองและจองอยู่บ่อยๆ ฉันได้รับการติดต่อจากองค์กรให้บอกข้อมูลเกี่ยวกับ GSoD เห็นโอกาสนี้แล้วที่จะได้มีส่วนร่วมในโปรเจ็กต์ จากความเชี่ยวชาญของฉันโดยตรง
ข้อมูลอ้างอิง 9 รายการ
- [ความช่วยเหลือของ Wikibooks:การให้ข้อมูล],
- [Wikibooks:นโยบายและหลักเกณฑ์]
- [หลักเกณฑ์การแก้ไขที่จัดระเบียบด้วย OpenStreetMap]
- [คู่มือสำหรับผู้เขียนโครงการเอกสารประกอบสำหรับ Linux (LDP)]
- [หลักสูตรระบบดิจิทัลเบื้องต้นของ MIT Openware เปิดหลักสูตร]
- [บทเรียนในวงจรไฟฟ้า -- วอลุ่ม IV - ดิจิทัล]
- [Wikibooks: วงจรดิจิทัล]
- [วิกิบุ๊ก: ดิจิทัลอิเล็กทรอนิกส์]
[โปรเจ็กต์โบรชัวร์ Linux]
[ความช่วยเหลือของ Wikibooks:การให้ข้อมูล] https://th.wikibooks.org/wiki/Help:Contributing
[Wikibooks:นโยบายและหลักเกณฑ์] https://en.wikibooks.org/wiki/Wikibooks:Policies_and_guidelines
[หลักเกณฑ์การแก้ไขขององค์กร OpenStreetMap] https://wiki.osmfoundation.org/wiki/Organised_Editing_Guidelines
[คู่มือผู้เขียนโครงการเอกสารประกอบสำหรับ Linux (LDP)] https://www.tldp.org/LDP/LDP-Author-Guide/html/index.html
[หลักสูตรห้องปฏิบัติการระบบดิจิทัลเบื้องต้นของ MIT Openware] https://ocw.mit.edu/courses/electrical-engineing-and-computer-science/6-111-introductory-digital-systems-laboratory-spring-2006/syllabus/
[บทเรียนในวงจรไฟฟ้า -- ระดับเสียงที่ 4 - ดิจิทัล] https://www.ibiblio.org/kuphaldt/electricCircuits/Digital/index.html
[Wikibooks: วงจรดิจิทัล] https://th.wikibooks.org/wiki/Digital_Circuits
[Wikibooks: ดิจิทัลอิเล็กทรอนิกส์] https://en.wikibooks.org/wiki/Digital_Electronics
[โครงการโบรชัวร์ Linux] http://lbproject.sourceforge.net/