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