หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- CircuitVerse
- ผู้เขียนด้านเทคนิค:
- ปรากาติ
- ชื่อโปรเจ็กต์:
- เอกสารประกอบและคู่มือผู้ใช้
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
หลังจากวิเคราะห์กลุ่มเป้าหมายอย่างละเอียดและเอกสารผู้ใช้ที่เป็นปัจจุบันแล้ว เราขอเสนองานด้านเอกสารประกอบด้านล่างนี้
1) เพิ่มวิดีโอแนะนำเพื่อแสดงเวิร์กโฟลว์ยอดนิยมและปรับปรุงประสบการณ์การเริ่มต้นใช้งาน วิดีโอจะสรุปแนวคิดเดียว วิดีโอจะชี้ทางขณะที่ทำการดำเนินการนั้นบนหน้าจอ
ลิงก์ตัวอย่างวิดีโอบทแนะนำการใช้เครื่องมือวิเคราะห์แบบรวมมีอยู่ที่นี่ https://www.youtube.com/watch?v=7FkeqBYcd1w หมายเหตุ 1: วิดีโอนี้แสดงตัวอย่างเนื้อหาที่มีอยู่ แต่มีไว้เพื่อแสดงสไตล์ในการใช้คำอธิบายประกอบเพื่อสร้างสไตล์ของวิดีโอที่สอดคล้องกัน หมายเหตุ 2: เมื่อเริ่มทำงานกับ CircuitVerse ฉันจะซื้อใบอนุญาตสำหรับซอฟต์แวร์และผลิตภัณฑ์ขั้นสุดท้ายจะไม่มีลายน้ำ
หัวข้อที่แนะนำสำหรับขั้นตอนการทำงานของบทแนะนำแบบวิดีโอ: --เริ่มต้นใช้งาน CircuitVerse: ดูวิดีโอบทแนะนำนี้เพื่อทัวร์ชม CircuitVerse แบบคร่าวๆ --การใช้เครื่องมือวิเคราะห์แบบผสม: ดูวิดีโอแนะนำนี้เพื่อเรียนรู้วิธีสร้างวงจรโดยใช้ข้อมูลตารางความจริง --การส่งออกภาพความละเอียดสูง: ดูบทแนะนำวิดีโอนี้เพื่อเรียนรู้วิธีการส่งออกภาพความละเอียดสูงของวงจรในรูปแบบต่างๆ --การใช้วงจรย่อยสำหรับการออกแบบที่มีโครงสร้าง: ดูวิดีโอแนะนำนี้เพื่อเรียนรู้วิธีสร้างวงจรย่อยเพื่อลดความซับซ้อนของโครงสร้างวงจรที่ซับซ้อน --การใช้เครื่องมือตัวแปลงเลขฐานสิบหกที่ถังฐานสิบหก: ดูวิดีโอนี้เพื่อเรียนรู้วิธีการใช้เครื่องมือออกแบบวงจรย่อยและตัวแปลงเลขฐานสิบหก --การดูแผนภาพระยะเวลาของวงจรของวงจรที่ต้องการ: ดูวิดีโอบทแนะนำนี้เพื่อเรียนรู้วิธีแสดงแผนภาพระยะเวลาของวงจรของวงจรที่ต้องการ
วิดีโอแนะนำบางรายการสามารถเชื่อมโยงกันในหน้าเว็บและเอกสารประกอบของผู้ใช้ได้
2) สร้างหน้า Landing Page สำหรับบทแนะนำเพื่อให้ภาพรวมคร่าวๆ เกี่ยวกับแพลตฟอร์ม CircuitVerse และแสดงมุมมองแบบกราฟิกของเวิร์กโฟลว์ต่างๆ ผู้ใช้จะเข้าถึงหน้า Landing Page ของบทแนะนำในเว็บไซต์ Circuitverse GitHub ซึ่งจะให้ข้อมูลสรุปคร่าวๆ ของบทแนะนำต่างๆ ที่มีให้สำหรับเวิร์กโฟลว์ของเนื้อหาแต่ละแบบ เพื่อให้ผู้ใช้ดูและเลือกบทแนะนำต่างๆ ได้ตามความต้องการ ด้านล่างคือตัวอย่างคร่าวๆ ของโครงสร้างหน้าเว็บของหน้า Landing Page ของบทแนะนำ
3) สร้างบทแนะนำทีละขั้นตอนเพื่อให้ความรู้แก่ผู้ใช้เกี่ยวกับวิธีใช้เครื่องมือในการเรียนรู้และวิเคราะห์พฤติกรรมของวงจรพื้นฐานและซับซ้อน สอนเครื่องมือด้วยการเล่นกับเครื่องมือ หลังจากดูโปรเจ็กต์แนะนำของ CircuitVerse ฉันเสนอให้เพิ่มบทแนะนำอย่างน้อย 5 รายการสำหรับผู้ใช้ระดับเริ่มต้นและระดับกลางเพื่อปรับปรุงประสบการณ์การเริ่มต้นใช้งาน การแสดงขั้นตอนการทำงานที่สมบูรณ์ บทแนะนำแต่ละบทจะแสดงบทแนะนำ ตามด้วยขั้นตอนการออกแบบ รายการคอมโพเนนต์ วิธีการทีละขั้นตอน และแบบฝึกหัดที่ฝึกฝน สำหรับเวิร์กโฟลว์ที่ซับซ้อน วิดีโอจะครอบคลุมแต่ละส่วนของแนวคิดโดยรวม
ไปที่ลิงก์นี้เพื่อดูตัวอย่างบทแนะนำ: สร้างตัวถอดรหัสกลุ่ม 7 กลุ่ม: https://pragatijain.github.io/circuitverse/index.html
ตัวอย่างหัวข้อต่างๆ ได้แก่ --สร้างจอแสดงผล LED แบบต่อเนื่อง --สำรวจวิธีการทำงานของระลอกคลื่นที่ขนย้าย --ตอนที่ 1A: วิเคราะห์ตัวเปรียบเทียบแมกนิจูด 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 กลุ่ม : 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 ส่วนเพื่อดูการทำงานของวงจร จอแสดงผลแบบ 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 เช่น ต้องเปิดไฟ LED b และ c เพื่อแสดงหมายเลข 1
หากไฟ LED แสดงเลขทศนิยมไม่ถูกต้อง โปรดดูตาราง 3 และรูปที่ 10 และแก้ปัญหาการต่อสายไฟ ตารางที่ 3 แสดงการกำหนดค่า PIN ที่แสดงกลุ่ม 7 ส่วน