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