בדף הזה מופיעים הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Docs ל-Google Docs.
סיכום הפרויקט
- ארגון בקוד פתוח:
- CircuitVerse
- כותבים טכניים:
- Pragati
- שם הפרויקט:
- מסמכי תיעוד ומדריכים למשתמשים
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
אחרי ניתוח מעמיק של הקהל ושל מסמכי התיעוד הקיימים למשתמשים, הצעתי את המשימות הבאות בנושא תיעוד:
1) מוסיפים סרטוני הדרכה כדי להמחיש את תהליכי העבודה הפופולריים ולשפר את חוויית ההצטרפות. הסרטונים יתמקדו בקונספט אחד. בסרטונים יוצגו הוראות בזמן ביצוע הפעולה במסך.
הקישור הבא מפנה לסרטון הדרכה לדוגמה בנושא השימוש בכלי לניתוח משולב: https://www.youtube.com/watch?v=7FkeqBYcd1w הערה 1: הסרטון הזה הוא דוגמה לתוכן קיים, והוא נועד להראות איך אפשר להשתמש בהערות כדי ליצור סגנון סרטון עקבי. הערה 2: כשהתחלתי לעבוד ב-CircuitVerse ארכוש רישיון לתוכנה, והמוצר הסופי לא יכלול סימן מים.
הצעות לנושאים של סרטוני הדרכה על תהליכי עבודה: --תחילת העבודה עם CircuitVerse: כדאי לצפות בסרטון ההדרכה הזה כדי לקבל סיור מהיר ב-CircuitVerse --שימוש בכלי לניתוח משולב: כדאי לצפות בסרטון ההדרכה הזה כדי ללמוד איך ליצור מעגלים באמצעות נתונים של טבלת אמת. --ייצוא תמונות ברזולוציה גבוהה: בסרטון ההדרכה הזה מוסבר איך לייצא תמונות ברזולוציה גבוהה של המעגלים במספר פורמטים --שימוש במעגלים משניים לתכנון מובנה: בסרטון ההדרכה הזה מוסבר איך ליצור מעגלים משניים כדי לפשט את המבנה של מעגלים מורכבים --שימוש בכלי המרה של 16-ביט, 2-ביט ו-10-ביט: בסרטון ההדרכה הזה מוסבר איך להשתמש בכלי המרה של 16-ביט, 2-ביט ו-10-ביט לתכנון ולתיקוף של מעגלים. --תצוגה חזותית של תרשימי תזמון מעגלים למעגל נתון: בסרטון ההדרכה הזה מוסבר איך משתמשים יכולים להציג תרשימי תזמון מעגלים למעגל נתון.
ניתן לקשר בין חלק מסרטוני ההדרכה בין דפי אינטרנט לבין מסמכי תיעוד של משתמשים.
2) יוצרים דף נחיתה עם מדריך כדי לספק סקירה כללית קצרה על פלטפורמת CircuitVerse, וגם תצוגה גרפית של תהליכי העבודה השונים. המשתמשים ייגשו לדף נחיתה של מדריך באתר של Circuitverse GitHub, שיספק תיאור קצר של המדריכים השונים שמוצעים לתהליכי עבודה של תוכן שונים. כך המשתמש יכול לצפות במדריכים שונים ולבחור את המדריך שמתאים לצרכיו. בהמשך מוצגת דוגמה גסה למבנה הדף של דף הנחיתה של המדריך.
3) ליצור מדריכים מפורטים כדי ללמד את המשתמשים איך להשתמש בכלי כדי ללמוד ולנתח את ההתנהגות של מעגלים בסיסיים ומורכבים – ללמד את הכלי באמצעות משחק עם הכלי. בנוגע לפרויקטים הנבחרים של CircuitVerse, מומלץ להוסיף לפחות 5 מדריכים למתחילים ולמשתמשים ברמה בינונית כדי לשפר את חוויית ההצטרפות. כל הדרכה תכלול מבוא, תהליך עיצוב, רשימת רכיבים, הוראות מפורטות ותרגילים. בתהליכי עבודה מורכבים, הסרטונים יכסו חלק ספציפי מהקונספט הכולל.
בקישור הבא אפשר למצוא מדריך לדוגמה: יצירת מפענח של שבעה קטעים: https://pragatijain.github.io/circuitverse/index.html
בין הנושאים: --יצירת תצוגת LED מתגלגלת --הסבר על אופן הפעולה של מכונה מסכמת עם גל הולכה (ripple carry) --חלק 1A: ניתוח של מכשיר להשוואת עוצמות (magnitude comparator) של 4 ביט --חלק 1B: יצירת מחשבון הקסדצימלי --ניתוח הטמעה של מכונה עם מצב סופי (FSM)
4) שינוי המבנה של ניווט בסרגל הצד כדי לשפר את העקביות, הקריאוּת והעוצמה.
כלים לפרויקטים: 1) Camtasia לסרטוני הדרכה. השתמשתי בגרסת ניסיון כדי ליצור את הסרטון לדוגמה. כשאתחיל לעבוד ב-CircuitVerse, ארכוש רישיון לתוכנה והמוצר הסופי לא יכלול סימן מים. 2) מסמכי Google לכתיבת המדריכים שלי שאעדכן אותם מאוחר יותר ב-GitHub כדי לארח במאגר של CircuitVerse. 3) סימון Wiki ו-HTML לניהול התוכן שלי ב-GitHub.
ציר זמן לפני 16 באוגוסט הוספת תוכן לארגון ב-GitHub.
יצירת קשר עם הקהילה (17 באוגוסט עד 13 בספטמבר) כדאי להגדיר ערוץ תקשורת ושעה (עקב הפרשי שעות). לשפר את היעדים ולהגדיר ציפיות משני הצדדים. מידע נוסף על הקהילה ועל המוצר דיון וחתימה על מבנה המסמכים המוצע עם החונכים וחברים אחרים בארגון.
תקופת התיעוד פרויקט זה יתבצע בהתאם להנחיות לגבי אורך הפרויקט הרגיל (סה"כ 11 שבועות, מ-14 בספטמבר 2020 עד 30 בנובמבר 2020). אקדיש כ-20 שעות בשבוע להשגת היעדים שמפורטים בהמשך. בנוסף ליעדים האלה, אשתתף בפגישות עם המנטורים ובתקשורת איתם במהלך התקופה הזו, לפי הצורך. אעבוד עם החונכים כדי לקבוע מה הזמן המתאים ביותר לכך. הערה: ציר הזמן הזה גמיש ומכיר בעובדה שהצרכים הארגוניים עשויים להשתנות. מסגרות הזמן הרחבות מאפשרות גמישות ויכולת לשנות את המיקוד לפי הצורך.
שבוע 1: סקירה של ציוני הדרך שזוהו וצמצום שלהם מאגר Fork CircuitVerse והורדה שלו למחשב שלי דיון עם החונכים לגבי הסגנון של סרטונים, ופיתוח תבנית מסך פתיחה של סרטון, מוזיקה למילוי בקשות לכותר ולמסכי הסיום, ומידע נוסף שכדאי לכלול. בדיקת הנושאים של סרטוני ההדרכה וקבלת אישור עליהם זיהוי הנושאים של סרטוני ההדרכה וקבלת אישור עליהם. בדיקת מבנה הניווט בסרגל הצד וקבלת אישור
שבוע 2: פיתוח תבנית הדרכה וקבלת אישור מהמנטור, יצירת דף נחיתה להדרכות לאירוח ההדרכות
שבוע 3, 4, 5: הוספת סרטוני הדרכה להדגמת תהליכי עבודה שונים בסימולטור
שבוע 6, 7, 8, 9: יצירת מדריכים למעגלים פשוטים ומורכבים שונים
שבוע 10: שינוי המבנה של הניווט בסרגל הצד כדי לשמור על עקביות ולשפר את חוויית ההצטרפות של המשתמשים
שבוע 11: הגהה של העבודה שלי לאיתור שגיאות הקלדה ושגיאות הקלדה.
דוגמאות רלוונטיות לעבודות של CircuitVerse
*בקישור הזה אפשר למצוא מדריך לדוגמה: יצירת מפענח של שבעה קטעים. : https://pragatijain.github.io/circuitverse/index.html
*קישור לסרטון הדרכה לדוגמה לשימוש בכלי הניתוח המשולב זמין כאן. https://www.youtube.com/watch?v=7FkeqBYcd1w הערה 1: הסרטון הזה מדגים תוכן קיים, אבל הוא נועד להדגים איך אפשר להשתמש בהערות כדי ליצור סגנון סרטון עקבי. הערה 2: כשאתחיל לעבוד ב-GDevelop, ארכוש רישיון לתוכנה והמוצר הסופי לא יכלול סימן מים.
*דף הנחיתה של המדריך ל-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 הקטעים ב-CircuitVerse, נעשה את הפעולות הבאות: משתמשים בכלי הניתוח השילובי שזמין בסימולטור של CircuitVerse כדי לנסח את טבלת האמת. לאחר מכן נשתמש בטבלת האמת הזו כדי ליצור את המעגל בתוך הסימולטור. המעגל הזה יפנה את הפלט לצג LED בעל שבעה מקטעים. כדי לראות את המעגל שלנו בפעולה, מחברים את התוויות המתאימות של המעגל המשולב לפלט המתאים של צג ה-LED עם שבעה קטעים. צג שמורכב מ-7 קטעים הוא מכשיר אלקטרוני להצגת ספרות עשרוניות מ-0 עד 9.יש לנתח את התנהגות המעגל באמצעות נתוני טבלת האמת. טבלת אמת בטבלה 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, נורות ה-LED b ו-c חייבות לפעול.
אם נורית ה-LED לא מציגה את המספר העשרוני הנכון, צריך לעיין בטבלה 3 ובאיור 10 ולפתור את הבעיות בקישורי החיווט. בטבלה 3 מפורטת הגדרת הפינים של תצוגת 7 הפלחים.