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