בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון בקוד פתוח:
- שפת Julia
- כותבים טכניים:
- mkg33
- שם הפרויקט:
- המסמכים המאוחדים של למידת מכונה מדעית
- אורך הפרויקט:
- Long running (5 months)
תיאור הפרויקט
אני רוצה לעבוד על איחוד הארגון של SciML כי יש הרבה מקום לשיפור בתחום הזה, והשלמת הפרויקט הזה תספק ללא ספק יתרונות מיידיים גם למתכנתים של Julia וגם לתורמים/מנהלים הפעילים של SciML. החבילות שמפוזרות ברחבי SciML כוללות כמה כלים שימושיים מאוד, אבל תמיד יש סכנה שהן לא ייבחנו (במיוחד על ידי משתמשים חדשים), פשוט כי המשתמש לא הצליח למצוא את החבילה ולהחיל אותה על הבעיה הספציפית.
זה די מתסכל, כי המטרה העיקרית של החבילות היא להגיע לקהל רחב של מתכנתים (מתחילים ומומחים כאחד). כדי למנוע את המצב שמתואר למעלה, אני מציע לעדכן באופן יסודי את 'דף הבית' של מסמכי התיעוד של SciML וליצור מעין מרכז שבו המשתמשים יוכלו לעיין בחבילות קשורות ולחקור את הסביבה העסקית ההולכת וגדלה. הוא יכול גם לשמש כנקודת התייחסות חשובה למשתמשים מנוסים יותר, ולאפשר להם לעבוד בצורה יעילה יותר.
קודם כול, צריך לתקן את התיעוד הקיים של כל החבילות שקשורות לבעיות הסגנוניות הבסיסיות ביותר (כמו איות, פיסוק, דקדוק וכו'). כדי להבטיח עקביות בסגנון, ל-SciML צריך להיות מדריך סגנון מוגדר (חיוני לביצוע שינויים רטרוספקטיביים ולשימוש עתידי). זה יהיה בזבוז זמן להתחיל מהתחלה. במקום זאת, הוא צריך להתבסס על המוסכמות הקיימות של Julia ולכלול רשומות חדשות לבעיות ספציפיות ל-SciML.
אחרי שנסיים את מדריך הסגנון, אני מתכוון לעדכן את המסמכים הקיימים בשלב השני של הפרויקט. זה יגרום לתיעוד מראה מקצועי ויציב יותר. כבר יצרתי כמה בקשות משיכה שממחישות את הגישה שלי למשימה הזו. בשלב הזה, בכוונתי לפתח (ולהטמיע) מערכת יעילה של ציטוטים ביבליוגרפיים. המשימה הראשונה ביותר תהיה עדכון הדף המיושן בנושא ציטוטים ביבליוגרפיים.
השלב השלישי, שעשוי להיות החלק החשוב ביותר, יהיה תכנון מפת הדרכים של SciML, שתדגיש את האינטראקציה בין החבילות המפוזרות. ככל שהקשר בין שתי חבילות חזק יותר (ביחס לבעיה או לקוד עצמו), כך הן צריכות להופיע קרוב יותר ברשימת 'מידע נוסף'. אני מציע ליצור שני מפתחות המלצות: אחד לדמיון בקוד והשני לדמיון בין בעיות. כך המשתמשים יוכלו לזהות חבילות מועילות אחרות מהר יותר מאשר על ידי גלישה מאומצת במאגרים ובמסמכים הרלוונטיים. במקום לרשום את כל החיבורים האפשריים בין החבילות, אני מעדיף להתמקד בחיבורים הגדולים יותר ולנסות להציג את הקישורים שלהם לחבילות קטנות יותר (השיטה הזו תורחב גם לעדכון מדריכים שבהם צריך לציין את הקשר לחבילה אחרת). הגישה הזו מבטיחה שרשימות 'ראו גם' יהיו מועילות, בלי לכלול רשימה מקיפה של שילובי חבילות.