בדף הזה מופיעים הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Docs ל-Google Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- Open3D
- כותבים טכניים:
- רוהאן ראטהי
- שם הפרויקט:
- מסמכי תיעוד טכניים של Python ו-C++ API
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
תקציר:
הפרויקט יתחלק לארבעה חלקים: שדרוג והרחבה של מדריך התורמים של Open3D מסמכי תיעוד מלאים של ממשק ה-API ל-Python מסמכי תיעוד מלאים של ממשק ה-API ל-C++ מסמכי תיעוד ברמה גבוהה של מבני הנתונים המרכזיים
תיאור:
בפרויקט שלי, אני מתכנן לפצל את הפרויקט ל-4 חלקים:
אני מתכנן להשלים ולעדכן את מדריך התרומה למשתמשים חדשים. המדריך מספק הוראות מפורטות שמסבירות איך לבנות את קוד המקור, לבנות את מסמכי התיעוד ולהצטרף לקהילת המפתחים. בנוסף למדריך בכתב, אני מתכוון ליצור סרטון שבו אציג את השלבים המדויקים ליצירת קוד המקור של ערוץ YouTube. אוסיף גם מדריך למפתחים חדשים שרוצים לתרום לתיעוד על ידי ביצוע שינויים בקוד המקור שנוצר על ידי sphinx באמצעות pybind ו-doxygen.
להרחיב את מסמכי התיעוד של Python API. נכון לעכשיו, ממשק ה-API ל-Python מכיל docstrings בסיסיים של הכיתות ופונקציות החברים, שמספקים תיאור מעורפל של הפונקציונליות. אני אנסה לנסח מחדש את התיעוד של Python API כדי שיהיה קל יותר להבין את ה-API והפונקציונליות שלו תהיה ברורה יותר. בנוסף, אני מתכוון להוסיף קישורים למושגי הגרפיקה הרלוונטיים בתלת-ממד שמשמשים בתחומים שונים (למשל: מטריקס פנימי שמשמש במצלמה).
ממלאים את מסמכי התיעוד של C++ API. בשלב הזה אין מסמכי docstring מקבילים במסמכי התיעוד של C++ לעומת מסמכי התיעוד של Python. בכוונתי לתעד באופן מפורט את הכיתות ואת התפקידים הקשורים אליהן וחברי הנתונים שלהן .
מסמכים ברמה גבוהה ונמוכה של מבני הנתונים העיקריים. יש לי כוונה להבין את הקוד של מבני נתונים שונים כמו TriangleMesh, LineSet, Octree ולהוסיף הערות ב-codebase, גם כדי לעזור למפתחים להבין את התוכן באופן חדש וגם להשתמש בו. בנוסף, אנחנו משפרים את המדריכים כדי לספק תיעוד ברמה גבוהה לגבי השימוש והמושגים שקשורים למבנים. אציג דוגמאות מפורטות לשימוש ואוסיף קישורים רלוונטיים למושגים שקשורים למבנים. אם יהיה לי זמן, אמשיך לעבוד על משימות פשוטות יותר, כמו תיעוד של דרכים לבצע משימות מסוימות שיכולות לעזור למשתמשים חדשים להצטרף לתוכנה.
לוח הזמנים של הפרויקט –
1 באוגוסט עד 1 בספטמבר:
נכיר את המנטור שלי ונדבר לעומק על רמת התיעוד הנדרשת בחלקים שונים של קוד המקור, וגם על מידת הפירוט הנדרשת בתיעוד ברמה נמוכה לעומת ברמה גבוהה. בנוסף, אשתמש בזמן הזה כדי להבין את קוד המקור ולחקור את המושגים, כדי שאוכל לתעד אותם בצורה טובה יותר.
שבוע 1 ו-2:
אעדכן וארחיב את המדריך לשותפים ליצירת תוכן. אשתפר את המסמכים בנושא פיתוח קוד המקור. אוסיף גם קטע בנושא תיעוד, שבו אסביר איך שותפים חדשים יכולים לעזור בתיעוד. אצור גם סרטון ב-YouTube עם הוראות מפורטות ליצירת קוד המקור.
שבוע 3 עד 5:
אעבוד על הרחבת Python API. לשכתב את המסמכים הקיימים ולכתוב מסמכים מפורטים על החברים הקיימים. אוסיף גם קישורים רלוונטיים למושגים קשורים כדי שהמשתמשים יוכלו להכיר טוב יותר את המושגים הקשורים.
שבוע 6 עד 8:
המסמכים הנוכחיים של C++ לא מלאים ברוב חלקי הספרייה, ולכן אקדיש את רוב הזמן למילוי המסמכים של C++
שבוע 9 עד 11:
במהלך התקופה הזו אעבוד על מבני הנתונים המרכזיים. שינוי המבנה של מדריכי העבודה של כל מבנה נתונים, מתן סקירה כללית ברמה גבוהה ותיעוד של פרטי שימוש לדוגמה.
השבוע האחרון:
בשבוע האחרון אשתמש בהכנת הדוח הסופי על העבודה שעשיתי במהלך תקופת התיעוד של 12 שבועות. בנוסף, אשתמש בזמן הזה כדי לבדוק את המסמכים ולסיים אותם.