בדף הזה מופיעים הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Docs ל-Google Docs.
סיכום הפרויקט
- ארגון בקוד פתוח:
- שפת Julia
- כותבים טכניים:
- שואו ליו
- שם הפרויקט:
- מסמכי העזרה של LightGraphs 2.0 ומדריכים ידידותיים למשתמש של JuliaGraphs
- אורך הפרויקט:
- Long running (5 months)
תיאור הפרויקט
בפרויקט הממושך הזה, אשפר את האתר ואת התיעוד של המודולים ב-JuliaGraphs. באופן ספציפי, העבודה שלי תכלול, בין היתר, את התכנים הבאים.
LightCharts Docs 2.0 עד 10 שבועות
- סקירה כללית: LightGraphs.jl היא חבילת גרפים קלה ומותאמת ל-Julia, שמשמשת כליבת הסביבה העסקית של JuliaGraphs. הגרסה 2.0 של LightGraphs שצפויה בקרוב מייצגת שינוי מהותי ב-LightGraphs API. אקפיד שהמסמך יכלול את התכונות העדכניות והטובות ביותר של LightGraphs.
- תוצרים: אבדוק את מסמכי התיעוד הקיימים של ה-API כדי לראות אילו מסמכים אפשר להשאיר ללא שינוי, ואנתח את השינויים שבוצעו במהדורה 2.0 כדי לוודא שהם מתועדים כראוי עם דוגמאות. במהלך התהליך הזה, אכתוב פוסטים שבהם אציג את השינויים העיקריים בגרסה 2.0. כדי לעזור למתחילים להבין טוב יותר את LightGraphs, אצור מדריכים למתחילים למי שמעוניין לעשות את הצעד הראשון בעולם השימוש בגרפים ב-Julia.
- הערות: בפרויקט הזה, נעשה שימוש ב-Documenter.jl כגנרטור מסמכים ליצירת המסמכים של LightGraphs. חוץ מהפניות API למודולים כמו Coloring.jl, אני צריך אותן גם עבור מודולים המשנה כמו greedy_color.jl. אבדוק איך להוסיף אותם כדי לחדש את התיעוד של Light Graphs. בנוסף, תורת הגרפים היא תחום מתמטיקה טכני למדי, ולא ברור למי שאין לו רקע במתמטיקה. אני עוסק במחקר אקדמי כבר כמעט שנתיים וכתבתי הרבה פוסטים בבלוג באתר האישי שלי, כך שאני יכול להסביר את המהות של אלגוריתמים שונים ולתת טיפים לגבי האלגוריתמים שאפשר להשתמש בהם במצבים שונים בזמן היצירה של מדריכי למתחילים.
מדריכים של JuliaGraphs – 10 שבועות
- סקירה כללית: חלק גדול מהמסמכים של חבילות JuliaGraphs מיועדים למפתחים. אצרף כמה דוגמאות פשוטות ואמחיש את השימוש בכל תכונה, כדי להפוך אותה לנגישה יותר למשתמשים.
- תוצרים: אבדוק את מדריכי LightGraphs הקיימים כדי לראות אילו חומרי לימוד צריך להוסיף, ואדגים את השימוש בכל תכונה ואת הסיבות לשימוש בה. לאחר מכן אמשיך לפעול לפי JuliaGraphsTutorials כדי להרחיב את המדריכים של JuliaGraphs, כולל המדריך למתחילים בסביבה העסקית של LightGraphs.
- הערות: התוכן של JuliaGraphsTutorials לא מספיק מקיף כרגע, והמסמכים שצוינו למעלה מיועדים בעיקר לחבילת LightGraphs. אם יהיה לי זמן, אוסיף גם מדריכים למערכי מודולים אחרים ב-JuliaGraphs, כמו GraphPlot.jl, MetaGraphs.jl ו-SimpleWeightedGraphs.jl.
אתר המרכזי של JuliaGraphs – 4 שבועות
- סקירה כללית: האתר המרכזי של JuliaGraphs מציע סקירה כללית של חבילות המערכת האקולוגית. עם זאת, הוא עדיין מיועד בעיקר לתיאור ואפשר לשפר אותו כדי להפוך אותו למקור המידע הראשון עבור אנשים שמתחילים לעבוד עם תרשימים בג'וליה. אמצא דרך אינטואיטיבית עם תצוגה חזותית כדי להדגיש את התכונות של חבילות שונות של JuliaGraphs.
- תוצרים: אציע תרחישים לדוגמה כדי להדגיש את הפונקציונליות של חבילות JuliaGraphs, ואבצע בדיקה כדי לוודא שהן עדיין רלוונטיות ונתמכות. אצור קטע שבו אבליט את השימושים השונים של החבילות השונות בתחומים שונים (בריאות, חינוך וכו'). אם יהיה לך זמן, אחקור הסברים חזותיים לגבי האלגוריתמים שמשמשים בתרשימים.
- הערות: חבילות JuliaGraphs רבות נמצאות בשימוש נרחב בדומיינים שונים. בנוסף לתוספים ליצירת תרשימים כמו DiGraph for NetworkViz, אכלול גם כמה אפליקציות אחרות בנושאים ספציפיים, כמו MetaGraph for BioStructures בביולוגיה, DijkstraState for TrafficAssighnment בתכנון עירוני, DiGraph for TreeView בחינוך, וכו'.