דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- CircuitVerse
- כתב טכני:
- פרגאטי
- שם הפרויקט:
- מסמכים ומדריכים למשתמשים
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
לאחר ניתוח מעמיק של הקהל והתיעוד הקיים הזמין למשתמשים, אני מציע את משימות התיעוד הבאות:
1) הוספת סרטוני הדרכה להדגמת תהליכי העבודה הפופולריים ולשיפור חוויית השימוש בתהליך ההצטרפות. בסרטונים מתואר קונספט אחד. הסרטונים יתנו כיוון במהלך ביצוע הפעולה הזו במסך.
קישור לדוגמה לסרטון של הדרכה בנושא השימוש בכלי הניתוח המשולב זמין כאן: https://www.youtube.com/watch?v=7FkeqBYcd1w הערה 1: הסרטון הזה מדגים תוכן קיים, אך הוא נועד להראות את הסגנון שבו ניתן להשתמש בהערות כדי ליצור סגנון סרטון עקבי. הערה 2: כשאתחיל לעבוד ב-CrcuitVerse, ארכוש רישיון לתוכנה, והמוצר הסופי לא יכלול סימן מים.
נושאים מוצעים לתהליכי העבודה של סרטוני ההדרכה: --תחילת העבודה עם CircuitVerse: צפייה בסרטון ההדרכה הזה לצורך סיור קצר ב-CiricuitVerse --שימוש בכלי הניתוח המשולב: צפו בסרטון ההדרכה הזה כדי ללמוד כיצד ליצור מעגלים באמצעות נתונים של טבלת האמת. -ייצוא תמונות ברזולוציה גבוהה: צפה בסרטון ההדרכה הזה כדי ללמוד כיצד לייצא תמונות ברזולוציה גבוהה של המעגלים שלך בפורמטים מרובים. -שימוש בתת-מעגלים לצורך עיצוב מובנה: צפה בסרטון ההדרכה הזה כדי ללמוד כיצד ליצור מעגלים משניים לפישוט המבנה של מעגלים מורכבים -שימוש בכלי הממיר Hex-Bin-Dec: צפו בסרטון ההדרכה הזה כדי ללמוד כיצד להשתמש בכלי תכנון Hex-Bin-Dec. -- הדמיית דיאגרמות תזמון מעגלים עבור מעגל נתון: צפה בסרטון הדרכה זה כדי ללמוד כיצד משתמשים יכולים להמחיש דיאגרמות תזמון מעגלים עבור מעגל נתון.
ניתן לקשר חלק מסרטוני ההדרכה בדפי אינטרנט ובתיעוד משתמש.
2) ליצור דף נחיתה של מדריך כדי להציג סקירה קצרה של פלטפורמת CircuitVerse וכן לספק תצוגה גרפית של תהליכי העבודה השונים. למשתמשים תהיה גישה לדף נחיתה של מערך שיעור באתר Circuitverse GitHub. בדף זה מתוארים בקצרה של מערכי השיעור השונים המוצעים לתהליכי עבודה שונים בתוכן. כך המשתמשים יכולים לצפות במדריכים שונים ולבחור אותם בהתאם לצרכים שלהם. בהמשך מוצגת דוגמה גסה של מבנה הדף של דף הנחיתה של המדריך.
3) ליצור מדריכי שלב-אחר-שלב כדי ללמד את המשתמשים כיצד להשתמש בכלי כדי ללמוד ולנתח את ההתנהגות של מעגלים בסיסיים ומורכבים - ללמד את הכלי על ידי משחק עם הכלי. באשר לפרויקטים המומלצים של CircuitVerse, אני מציע להוסיף לפחות 5 מדריכים למשתמשים ברמה התחלתית או בינונית כדי לשפר את חוויית ההצטרפות. כל מדריך מתואר תהליך עבודה מלא, כולל מבוא למדריך ואחריו תהליך עיצוב, רשימת רכיבים, הוראות מפורטות ותרגילים לתרגול. בתהליכי עבודה מורכבים, הסרטונים יכסו חלק נפרד של רעיון כללי.
בקר בקישור הזה כדי לצפות במדריך לדוגמה: בניית מפענח 7 פלחים: https://pragatijain.github.io/circleuitverse/index.html
הנושאים כוללים: --בניית תצוגת LED מתגלגלת --בדיקת האופן שבו פועל בורר מצב גלים --חלק 1א: ניתוח משווה של עוצמה של 4 ביט --חלק 1ב: בניית מחשבון הקסדצימלי --ניתוח הטמעה של מכונה עם מצב סופי (FSM)
4) שינוי המבנה של סרגל הצד לניווט לשיפור העקביות, הקריאות והלכידות.
כלים לפרויקט 1) Camtasia לסרטוני הדרכה. השתמשתי בגרסת ניסיון ליצירת הסרטון לדוגמה. כשאתחיל לעבוד ב-CirCuitVerse, אני ארכוש רישיון לתוכנה, והמוצר הסופי לא יכלול סימן מים. 2) מסמכי Google לכתיבת המדריכים שלי, שאעדכן בהמשך ב-GitHub ואארח במאגר של CircuitVerse. 3) תגי עיצוב של Wiki ו-HTML לניהול התוכן שלי ב-GitHub.
לוח זמנים לפני 16 באוגוסט הוספת תכנים לארגון ב-GitHub.
גיבוש קהילתי (17 באוגוסט עד 13 בספטמבר) הגדרת ערוץ ושעת תקשורת (עקב הפרשי שעות). שפרו את היעדים שלי והגדירו ציפיות משני הצדדים. למידע נוסף על הקהילה והמוצר. קיים דיון לגבי מבנה המסמכים המוצע עם המנטורים וחברים אחרים בארגון.
תקופת התיעוד הפרויקט הזה יהיה תואם להנחיות הסטנדרטיות לפרויקט באורך 11 שבועות, מ-14.9.2020 עד 30.11.2020. אקדיש כ-20 שעות בשבוע כדי להשלים את היעדים המתוארים בהמשך. בנוסף ליעדים האלה, אשתתף בפגישות ובתקשורת של חונכים במהלך התקופה הזו, לפי הצורך. אני אעבוד עם המנטורים כדי להחליט מה הזמן הכי טוב לעשות זאת. הערה: ציר הזמן הזה גמיש ומכיר את העובדה שצורכי הארגון יכולים להשתנות. מסגרות הזמן הגדולות מאפשרות גמישות ויכולת לשנות מיקוד, לפי הצורך.
שבוע 1: בדיקת אבני הדרך שזוהו ושיפור שלהן מאגר Fork CircuitVerse והורדה שלו למכונה שלי דיון עם המנטורים לגבי הסגנון של הסרטונים, וגם פיתוח תבנית של מסך הפתיחה של הסרטון, כל מוזיקת מילוי לכותר ולמסכי הסיום ומידע נוסף שצריך לכלול. אפשר לבדוק את הנושאים של סרטון ההדרכה כדי לקבל אישור לזהות את נושאי המדריך ולקבל אותם לאישור. בדיקת מבנה הניווט של סרגל הצד והוא מאושר
שבוע 2: בניית תבנית של הדרכה וקבלת אישור מהמנטור יצירת דף נחיתה של מדריך לאירוח המדריכים
שבוע 3, 4, 5: הוספה של מדריכי וידאו כדי להדגים תהליכי עבודה שונים בסימולטורים
שבוע 6, 7, 8 ו-9: צרו מדריכים למעגלים פשוטים ומורכבים שונים
שבוע 10: מארגנים מחדש את סרגל הניווט בסרגל הצד כדי לשמור על עקביות, כדי לשפר את חוויית ההצטרפות של המשתמשים
שבוע 11: ביצוע הגהה לעבודה שלי לאיתור שגיאות הקלדה ושגיאות.
דוגמאות עבודה רלוונטיות של CircuitVerse
*בקרו בקישור הזה כדי לצפות במדריך לדוגמה: 'בניית 7 מפענח פלחים'. : https://pragatijain.github.io/circleuitverse/index.html
*קישור לדוגמה לסרטון הדרכה בנושא השימוש בכלי הניתוח המשולב זמין כאן. https://www.youtube.com/watch?v=7FkeqBYcd1w הערה 1: הסרטון הזה מדגים תוכן קיים, אבל הוא נועד להראות את הסגנון שבו אפשר להשתמש בהערות כדי ליצור סגנון עקבי בסרטון. הערה 2: כשאתחיל לעבוד ב-Gפיתוח, ארכוש רישיון לתוכנה והמוצר הסופי לא יכלול סימן מים.
*דף הנחיתה של המדריך של CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*הצגת ההצעה המלאה כמסמך של Google Docs: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
תבנית מדריך לדוגמה: 7 המפענח פלחים 7 המפענח פלחים
סקירה כללית:
במדריך הזה מתוארות שלבים שונים ליצירת מפענח 7 פלחים באמצעות CircuitVerse. מפענח הוא מעגל משולב שממיר מספר בינארי למספר העשרוני התואם. הוא מקבל ארבע סיביות של קלט ויש לו 7 פלטים.
תהליך התכנון
כדי ליצור את מעגל התצוגה של 7 הפלחים ב-CartuitVerse, נבצע את השלבים הבאים: כדי לנסח את טבלת האמת, השתמשו בכלי 'ניתוח משולב'. בעזרת טבלת האמת הזו ניצור את המעגל המתאים בתוך הסימולטור. המעגל הזה יפיק פלט לצג LED עם שבעה פלחים. כדי לראות את המעגל המתאים, חברו את התוויות המתאימות של המעגל המשולב לפלטים המתאימים של צג ה-LED עם 7 הפלחים. תצוגה של שבעה קטעים היא מכשיר תצוגה אלקטרוני להצגת ספרות עשרוניות מ-0 עד 9.מנתחים את התנהגות המעגל באמצעות נתוני טבלת האמת. טבלת האמת (Truth Table) טבלה 1 בהמשך מפרטת את הפלטים השונים לשילובים שונים של קלט עבור מפענח 7 קטעים.
רשימת רכיבי CircuitVerse
טבלה 2 מפרטת את הרכיבים השונים הנדרשים ליישום המעגל.
נסחו את טבלת האמת
כדי לנסח את טבלת האמת בסימולטור של CircuitVerse:
השלמת המסלול
עיינו באיור 10 כדי לחבר את כבלי הקלט המתאימים לתוויות המתאימות של המעגל המשולב לפלטים המתאימים של תצוגת שבעת הקטעים כדי להשלים את המעגל. בסרטון הזה מוצג הדמיה של מעגל חשמלי בן 7 קטעים, שנבנה בסימולטור CircuitVerse. קישור לסרטון: https://www.youtube.com/embed/tGTy4P-RxP0
נתחו את המעגל
החלפת ערכי קלט שונים (S3, S2, S1, S0) ואימות של טבלת האמת (מידע נוסף על טבלה 1) כדי לאמת את המעגל של מפענח שבעת הקטעים שהוטמע.
רכיב תצוגה של שבעה קטעים מכיל בתוכו 8 קטעי LED, כשקצה אחד של הנעצים נשלף אל מחוץ למודול, כפי שמתואר באיור 8. כדי שנורת ה-LED בקטע מסוים תאיר, הקטעים הרלוונטיים (שמסומנים בתוויות a, b, c, d, e, f, g באיור 10) חייבים להיות מופעלים כדי לייצג את המספרים מ-0 עד 9. למשל, כדי להציג את מספר 1, נורות ה-B ו-c חייבות להיות מופעלות.
אם בנורת ה-LED לא מופיע המספר העשרוני הנכון, עוברים לטבלה 3 ואיור 10 ומנסים לפתור את הבעיות בחיבור החיווט. בטבלה 3 מופיעה ההגדרה של קוד האימות בן 7 הפלחים.