דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- צ'אט בצוות קוד פתוח של Zulip
- כתב טכני:
- דררוסה
- שם הפרויקט:
- ארגון הקוד מחדש של ReadTheDocs ושל Docs API
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
אתמקד בשני תחומים ואעבוד בהם במקביל. אחת מהן היא לשפר את האיכות של zulip.readthedocs.io כדי שתורמים חדשים ייתקלו בפחות בלבול וספקות לאורך הדרך. באופן אידיאלי, התוצאה תהיה מסלול ברור ותמציתי מתרומה ראשונית ועד היכרות עם אופן הפעולה של Zulip. אני מתכנן גם לעבוד על zulipchat.com/api , api.md ו-openapi.md כדי שיהיה קל יותר להבין את תהליך התיעוד של נקודות קצה נוספות. שני החלקים בדרך כלל יכללו עדכון או פישוט של התוכן, הסתרת מאמרים, הוספת מסמכים חסרים למפתחים וגם כתיבה/בדיקה של קוד.
הפרויקט יכלול ארבעה שלבים. השלב הראשון יכלול פרויקטים קטנים של היכרות, כלי הכנה והבנה טובה יותר של צורכי התיעוד העדכניים. מטרת השלב השני תהיה לבנות, לפרט ולתעדף את העבודה בהקשר של היעדים של Zulip בעונת הסתיו הנוכחית. לאחר מכן אעבור לשלב היישום של הפרויקט. אמשיך ליצור קשר עם מנטורים ושאר קהילת המפתחים של Zulip כדי לקבל משוב. השלב האחרון יהיה להסתכל לאחור, לתקן לפי הצורך ולכתוב את דוח הפרויקט.
אני חושד שסדרי עדיפויות ומשימות מסוימות ישתנו לאורך תקופת העבודה כתוצאה ממשימות שכל האחרים עובדים עליהם, כולל החלטות של מפתחי הליבה. אני מצפה שהלמידה כיצד להסתגל היטב לשינויים כאלה היא היבט הכרחי בחוויה מוצלחת של GSoD. ייתכן שבשלב מסוים יהיה הגיוני לדחות רעיונות מוצעים למועד מאוחר יותר. באופן כללי, אתמקד בהקפדה שהעבודה שלי מניבה ערך להצלחה הכוללת של פרויקט הקוד הפתוח של Zulip.