דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- השפה של ג'וליה
- כתב טכני:
- Sophb
- שם הפרויקט:
- ממציא מחדש את אתר FluxML
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
מטרת ההצעה הזו היא לשפר את אתר התיעוד של Flux, כך שהמידע שהיא מכילה יהיה מובנה וימשוך משתמשים חדשים ומומחים. באופן ספציפי, המטרה היא לארגן מחדש את התיעוד הקיים לקטעים חדשים וליצור מדריך חדש לתחילת העבודה עבור משתמשים חדשים, שמרחיב את המדריך של Flux 60-mine-blitz.
הפרויקט כולל את השלבים הבאים:
נתחו את אתר התיעוד הנוכחי: בדקו את המידע הקיים והגדירו מדריך סגנון (למידע) ליצירת מדריכים חדשים.
הגדירו מבנה חדש למידע והמדריך לתחילת העבודה: עבדו עם המנטורים כדי לקבוע את הקטעים החדשים ולארגן מחדש את אתר התיעוד. בנוסף, הגדר תוכן עניינים עבור המדריך לתחילת העבודה באמצעות מערך השיעור של Flux 60-mine-blitz כנקודת התחלה, ולהסתמך עליו.
שינוי המבנה של המידע: עדכנו את האתר לתוכנית שהוגדרה בשיתוף עם המנטורים בשלב הקודם.
יצירת המדריך לתחילת העבודה: כותבים את הטיוטה הראשונה ובודקים אותה. לקבל משוב מהמנטורים. כשהמנטורים ואני נחליט שיש לנו גרסה סופית של המסמך הזה, אפרסם אותו באתר התיעוד.
(אופציונלי) המירו את המסמכים הקיימים בצורת README ל-HTML: אם נותר לי זמן מה לאחר שהשלמתי את ארבעת השלבים המרכזיים, אוכל להמיר את מדריכי הלימוד הקיימים שהם READMEs כך שיהיה קל יותר לגשת אליהם מהאתר.
כדי להשיג את מטרת הפרויקט, אעבוד בשיתוף פעולה הדוק עם קהילת Flux כדי להבין את המסמכים הקיימים ולקבוע את הגישה הטובה ביותר. אני גרה רק בבית הספר החדש של ג'וליה ואני מאמינה שהמידע הזה יעזור לי מאוד לקבוע את רמת המידע המתאימה למדריך החדש שיעזור לך להתחיל.
אתמקד במאמצים לוודא שהעבודה שלי עוזרת לקהילת Flux להתחיל להשתמשים חדשים. בנוסף, אתמקד בעזרה למשתמשים מנוסים לגלות תרחישים לדוגמה חדשים ולבחון את הפרטים הספציפיים יותר של Flux.