דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- SymPy
- כתב טכני:
- אלגנטיות
- שם הפרויקט:
- עקביות בין מחרוזות מסמכים
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
בפרויקט הזה, המטרה שלי היא לשפר את העקביות ב-docstrings של SymPy.
בעבודה עם המנטורים שלי, קודם הייתי מזהה את הפורמט הרצוי ל-docstring ב-codebase. לאחר מכן אצור מדריך עיצוב לתיעוד עבור כל docstrings בכל ה-codebase. העבודה שלי על הפרויקט תכלול גם הטמעה של המדריך החדש לעדכון מחרוזות מסמכים קיימים, תוך איסוף של חוסר עקביות אחר כמו שימוש בשפה או תנאים, וטיפול בהם. המנטורים שלי ואני נקבל יחד החלטות עריכה לגבי האופן שבו מתמודדים עם חוסר העקביות הנוסף הזה, והעדפות הסגנון שנגרמות כתוצאה מכך ייתווספו למדריך.
המטרה הסופית של הפרויקט תהיה פורמט תיעוד ומדריך סגנון, שיכולים לשמש גם מפתחים וגם שותפים ביצירת התוכן כדי לשמור על עקביות ב-docstring של SymPy עכשיו ובעתיד.