หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- CircuitVerse
- นักเขียนเชิงเทคนิค:
- Pragati
- ชื่อโปรเจ็กต์:
- เอกสารประกอบและคู่มือผู้ใช้
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
หลังจากทำการวิเคราะห์อย่างละเอียดเกี่ยวกับกลุ่มเป้าหมายและเอกสารประกอบผู้ใช้ที่มีอยู่ในปัจจุบัน เราขอเสนองานด้านเอกสารประกอบต่อไปนี้
1) เพิ่มวิดีโอบทแนะนำเพื่อสาธิตขั้นตอนการทำงานยอดนิยมและปรับปรุงประสบการณ์การเริ่มต้นใช้งาน วิดีโอจะอธิบายแนวคิดเดียว วิดีโอจะแสดงวิธีการขณะทำการดำเนินการนั้นบนหน้าจอ
ดูตัวอย่างลิงก์วิดีโอบทแนะนำสำหรับการใช้เครื่องมือวิเคราะห์แบบผสมได้ที่นี่ https://www.youtube.com/watch?v=7FkeqBYcd1w หมายเหตุ 1: แม้ว่าวิดีโอนี้จะอธิบายถึงเนื้อหาที่มีอยู่แล้ว แต่ก็มีไว้เพื่อแสดงรูปแบบวิธีการใช้คำอธิบายประกอบเพื่อสร้างสไตล์ของวิดีโอที่สอดคล้องกัน หมายเหตุ 2: เมื่อฉันเริ่มทำงานให้ CircuitVerse ฉันจะซื้อใบอนุญาตสำหรับซอฟต์แวร์นี้และผลิตภัณฑ์ขั้นสุดท้ายจะไม่มีลายน้ำ
หัวข้อแนะนำสำหรับเวิร์กโฟลว์ของวิดีโอบทแนะนำมีดังนี้ --เริ่มต้นใช้งาน CircuitVerse: ดูวิดีโอบทแนะนำนี้เพื่อทัวร์ชม CircuitVerse แบบย่อ --การใช้เครื่องมือการวิเคราะห์แบบผสม: ดูวิดีโอบทแนะนำนี้เพื่อดูวิธีสร้างวงจรโดยใช้ข้อมูลตารางความจริง --การส่งออกภาพความละเอียดสูง: ดูวิดีโอบทแนะนำนี้เพื่อเรียนรู้วิธีส่งออกภาพความละเอียดสูงของวงจรในรูปแบบต่างๆ --การใช้วงจรย่อยสำหรับการออกแบบที่มีโครงสร้าง: ดูวิดีโอบทแนะนำนี้เพื่อเรียนรู้วิธีสร้างวงจรย่อยเพื่อทำให้โครงสร้างของวงจรที่ซับซ้อนง่ายขึ้น -การใช้เครื่องมือแปลงเลขฐานสิบหก: ดูวิดีโอบทแนะนำนี้เพื่อเรียนรู้วิธีแปลงวงจรที่ซับซ้อน --การแสดงแผนภาพเวลาของวงจรสำหรับวงจรที่ระบุ: ดูวิดีโอบทแนะนำนี้เพื่อเรียนรู้ว่าผู้ใช้สามารถเห็นภาพแผนภาพเวลาของวงจรสำหรับวงจรที่ระบุได้อย่างไร
บทแนะนำแบบวิดีโอบางรายการจะลิงก์ข้ามหน้าเว็บและเอกสารประกอบสำหรับผู้ใช้ได้
2) สร้างหน้า Landing Page ของบทแนะนำเพื่อแสดงภาพรวมคร่าวๆ ของแพลตฟอร์ม CircuitVerse รวมถึงแสดงภาพเวิร์กโฟลว์ต่างๆ ผู้ใช้จะเข้าถึงหน้า Landing Page ของบทแนะนำในเว็บไซต์ GitHub ของ Circuitverse ซึ่งจะแสดงภาพรวมสั้นๆ ของบทแนะนำต่างๆ ที่มีให้สำหรับเวิร์กโฟลว์เนื้อหาที่แตกต่างกัน ซึ่งจะช่วยให้ผู้ใช้ดูและเลือกบทแนะนำต่างๆ เพื่อตอบสนองความต้องการได้ ด้านล่างนี้เป็นตัวอย่างคร่าวๆ ของโครงสร้างหน้าเว็บของหน้า Landing Page ของบทแนะนำ
3) สร้างบทแนะนำแบบทีละขั้นตอนเพื่อแจ้งให้ผู้ใช้ทราบวิธีใช้เครื่องมือเพื่อเรียนรู้และวิเคราะห์ลักษณะการทํางานของวงจรพื้นฐานและที่ซับซ้อน โดยสอนการใช้เครื่องมือด้วยการใช้เครื่องมือ จากโปรเจ็กต์แนะนำของ CircuitVerse เราขอแนะนำให้เพิ่มบทแนะนำอย่างน้อย 5 รายการสำหรับผู้ใช้ระดับเริ่มต้นและระดับกลางเพื่อปรับปรุงประสบการณ์การเริ่มต้นใช้งาน บทแนะนำแต่ละบทจะแสดงภาพเวิร์กโฟลว์ที่สมบูรณ์ โดยเริ่มจากข้อมูลเบื้องต้นของบทแนะนำ ตามด้วยกระบวนการออกแบบ รายการคอมโพเนนต์ วิธีการทีละขั้นตอน และแบบฝึกหัด สำหรับเวิร์กโฟลว์ที่ซับซ้อน วิดีโอจะครอบคลุมแต่ละส่วนของแนวคิดโดยรวม
ไปที่ลิงก์นี้เพื่อดูตัวอย่างบทแนะนำ: สร้างตัวถอดรหัส 7 Segments: https://pragatijain.github.io/circuitverse/index.html
หัวข้อบางส่วนมีดังนี้ --สร้างจอแสดงผล LED แบบเลื่อนไปเรื่อยๆ --สำรวจวิธีการทํางานของตัวบวกแบบ Ripple Carry --ส่วนที่ 1ก: วิเคราะห์ตัวเปรียบเทียบขนาด 4 บิต --ส่วนที่ 1ข: การสร้างเครื่องคิดเลขฐาน 16 --วิเคราะห์การใช้งานเครื่องกลสถานะแบบจำกัด (FSM)
4) แก้ไขโครงสร้างการนำทางด้านแถบด้านข้างเพื่อให้มีความสอดคล้อง เข้าใจง่าย และเชื่อมโยงกันมากขึ้น
เครื่องมือสำหรับโปรเจ็กต์ 1) Camtasia สำหรับวิดีโอบทแนะนำ ฉันเคยใช้เวอร์ชันทดลองเพื่อสร้างวิดีโอตัวอย่าง เมื่อเริ่มทำงานให้กับ CircuitVerse ฉันจะซื้อใบอนุญาตสำหรับซอฟต์แวร์และผลิตภัณฑ์ขั้นสุดท้ายจะไม่มีลายน้ำ 2) Google เอกสารสำหรับเขียนคู่มือ ซึ่งเราจะอัปเดตใน GitHub ในภายหลังเพื่อโฮสต์ในที่เก็บ CircuitVerse 3) มาร์กอัป Wiki และ HTML เพื่อจัดการเนื้อหาใน GitHub
ไทม์ไลน์ ก่อนวันที่ 16 สิงหาคม มีส่วนร่วมกับองค์กรใน GitHub
สานสัมพันธ์ของชุมชน (17 สิงหาคม - 13 กันยายน) กำหนดช่องทางและช่วงเวลาของการสื่อสาร (เนื่องจากเวลาที่แตกต่างกัน) ปรับแต่งเป้าหมายและกำหนดความคาดหวังของทั้ง 2 ฝ่าย ดูข้อมูลเพิ่มเติมเกี่ยวกับชุมชนและผลิตภัณฑ์ พูดคุยและสรุปโครงสร้างเอกสารที่เสนอกับที่ปรึกษาและสมาชิกคนอื่นๆ ในองค์กร
ระยะเวลาจัดทำเอกสาร โปรเจ็กต์นี้จะเป็นไปตามหลักเกณฑ์ระยะเวลาโปรเจ็กต์มาตรฐาน (รวม 11 สัปดาห์ ตั้งแต่ 14/9/2020 ถึง 30/11/2020) ฉันจะใช้เวลาประมาณ 20 ชั่วโมงต่อสัปดาห์เพื่อบรรลุเป้าหมายที่ระบุไว้ด้านล่าง นอกเหนือจากเป้าหมายเหล่านี้แล้ว เราจะเข้าร่วมการประชุมและการสื่อสารกับที่ปรึกษาในช่วงเวลานี้ตามที่จำเป็น เราจะหาเวลาที่เหมาะสมกับพี่เลี้ยงเพื่อนัดหมาย หมายเหตุ: ไทม์ไลน์นี้มีความยืดหยุ่นและรับทราบดีว่าความต้องการทางธุรกิจอาจเปลี่ยนแปลงได้ กรอบเวลาขนาดใหญ่ช่วยให้มีความยืดหยุ่นและสามารถเปลี่ยนจุดสนใจได้ตามต้องการ
สัปดาห์ที่ 1: ตรวจสอบและปรับแต่งเหตุการณ์สำคัญต่างๆ ที่ระบุไว้ แยกเก็บที่เก็บ CircuitVerse และดาวน์โหลดลงในเครื่องของเรา พูดคุยกับพี่เลี้ยงเกี่ยวกับสไตล์ของวิดีโอ รวมถึงพัฒนาเทมเพลตหน้าจอเปิดของวิดีโอ เพลงสำหรับใส่ในชื่อและหน้าจอปิด ตลอดจนข้อมูลเพิ่มเติมที่ควรใส่ ตรวจสอบหัวข้อวิดีโอบทแนะนำและขอรับการอนุมัติ ระบุหัวข้อบทแนะนำและขอรับการอนุมัติ ตรวจสอบโครงสร้างการนําทางด้านข้างและรับการอนุมัติ
สัปดาห์ที่ 2: สร้างเทมเพลตบทแนะนำและขอการอนุมัติจากผู้สอน สร้างหน้า Landing Page ของบทแนะนำเพื่อโฮสต์บทแนะนำ
สัปดาห์ที่ 3, 4, 5: เพิ่มบทแนะนำแบบวิดีโอเพื่อสาธิตเวิร์กโฟลว์ของโปรแกรมจำลองต่างๆ
สัปดาห์ที่ 6, 7, 8, 9: สร้างบทแนะนำสำหรับวงจรแบบง่ายและแบบซับซ้อน
สัปดาห์ที่ 10: ปรับโครงสร้างการนําทางด้านข้างให้สอดคล้องกันเพื่อปรับปรุงประสบการณ์การเริ่มต้นใช้งานของผู้ใช้
สัปดาห์ที่ 11: อ่านตรวจทานงานเพื่อหาคำที่พิมพ์ผิดและข้อผิดพลาด
ตัวอย่างงานที่เกี่ยวข้องใน CircuitVerse
*ไปที่ลิงก์นี้เพื่อดูตัวอย่างบทแนะนำ: สร้างตัวถอดรหัส 7 Segments : https://pragatijain.github.io/circuitverse/index.html
*ดูลิงก์วิดีโอตัวอย่างบทแนะนำเกี่ยวกับการใช้เครื่องมือการวิเคราะห์แบบผสมได้ที่ https://www.youtube.com/watch?v=7FkeqBYcd1w หมายเหตุ 1: แม้ว่าวิดีโอนี้จะแสดงตัวอย่างเนื้อหาที่มีอยู่ แต่ก็มีไว้เพื่อแสดงรูปแบบการใช้คำอธิบายประกอบเพื่อสร้างสไตล์วิดีโอที่สอดคล้องกัน หมายเหตุ 2: เมื่อเริ่มทำงานให้กับ GDevelop ฉันจะซื้อใบอนุญาตสำหรับซอฟต์แวร์และผลิตภัณฑ์ขั้นสุดท้ายจะไม่มีลายน้ำ
*หน้า Landing Page ของบทแนะนำ CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*ดูข้อเสนอฉบับเต็มในรูปแบบ Google เอกสาร: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
เทมเพลตบทแนะนำตัวอย่าง: ตัวถอดรหัส 7 หลัก ตัวถอดรหัส 7 หลัก
ภาพรวม:
บทแนะนำนี้จะแชร์ขั้นตอนต่างๆ ในการสร้างตัวถอดรหัส 7 หลักโดยใช้ CircuitVerse ตัวถอดรหัสคือวงจรแบบผสมที่แปลงตัวเลขฐานสองเป็นเลขฐานสิบ โดยรับอินพุต 4 บิตและมีเอาต์พุต 7 รายการ
ขั้นตอนการออกการออกแบบ
ในการสร้างวงจรจอแสดงผล 7 หลักใน CircuitVerse เราจะทำตามขั้นตอนต่อไปนี้ ใช้เครื่องมือการวิเคราะห์แบบผสมที่มีให้ในเครื่องจำลอง CircuitVerse เพื่อเขียนตารางความจริง จากนั้นเราจะสร้างวงจรภายในเครื่องจำลองโดยใช้ตารางความจริงนี้ วงจรนี้จะขับเอาต์พุตไปยังจอแสดงผล LED 7 หลัก เชื่อมต่อป้ายกำกับที่เกี่ยวข้องของวงจรผสมผสานกับเอาต์พุตที่เกี่ยวข้องของจอแสดงผล LED 7 Segments เพื่อดูการทำงานของวงจร จอแสดงผล 7 หลักเป็นอุปกรณ์แสดงผลอิเล็กทรอนิกส์สำหรับแสดงตัวเลขทศนิยมตั้งแต่ 0 ถึง 9 โปรดดูการวิเคราะห์การทำงานของวงจรโดยใช้ข้อมูลตารางความจริง ตารางความจริง ตารางที่ 1 ด้านล่างแสดงเอาต์พุตที่แตกต่างกันสําหรับชุดค่าผสมอินพุตที่แตกต่างกันสําหรับตัวถอดรหัส 7 หลัก
รายการองค์ประกอบ CircuitVerse
ตารางที่ 2 แสดงรายการคอมโพเนนต์ต่างๆ ที่จําเป็นสําหรับการติดตั้งวงจร
กำหนดตารางความจริง
ทําตามขั้นตอนด้านล่างเพื่อสร้างตารางความจริงภายในเครื่องจําลอง CircuitVerse
ต่อวงจรให้เสร็จ
โปรดดูรูปที่ 10 เพื่อต่อสายอินพุตที่เกี่ยวข้องสำหรับป้ายกำกับที่สอดคล้องกันของวงจรรวมกับเอาต์พุตที่เกี่ยวข้องของจอแสดงผล 7 ส่วนเพื่อให้วงจรเสร็จสมบูรณ์ วิดีโอนี้สาธิตวงจรจำลองตัวถอดรหัส 7 หลักที่สร้างภายในเครื่องจำลอง CircuitVerse ลิงก์วิดีโอ: https://www.youtube.com/embed/tGTy4P-RxP0
วิเคราะห์วงจร
สลับค่าอินพุตต่างๆ (S3, S2, S1, S0) และตรวจสอบตารางความจริง (ดูตารางที่ 1) เพื่อยืนยันวงจรตัวถอดรหัส 7 หลักที่ใช้
คอมโพเนนต์การแสดงผล 7 ส่วนมีไฟ LED 8 ส่วนอยู่ภายในและมีหมุดด้านหนึ่งออกจากโมดูลดังที่แสดงในรูปที่ 8 หากต้องการให้ LED ของกลุ่มใดกลุ่มหนึ่งสว่างขึ้น กลุ่มที่เกี่ยวข้อง (ติดป้ายกำกับเป็น a, b, c, d, e, f, g ในรูปที่ 10) จะต้องเปิดเครื่องเพื่อแสดงตัวเลขตั้งแต่ 0 ถึง 9 เช่น หากต้องการแสดงหมายเลข 1 จะต้องเปิด LED b และ c
หาก LED ไม่แสดงตัวเลขทศนิยมที่ถูกต้อง โปรดดูตารางที่ 3 และรูปที่ 10 และแก้ปัญหาการเชื่อมต่อการเดินสายไฟ ตารางที่ 3 แสดงการกำหนดค่าขาของจอแสดงผล 7 segment