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