הפרויקט Julia Language
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- שפת Julia
- כותבים טכניים:
- sophb
- שם הפרויקט:
- עיצוב מחדש של אתר FluxML
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
מטרת ההצעה הזו היא לשפר את אתר המסמכים של Flux כך שהמידע שהוא מכיל יהיה מובנה ומושך למתחילים ולמומחים. באופן ספציפי יותר, המטרה היא לארגן מחדש את המסמכים הקיימים בקטעים חדשים וליצור מדריך חדש למתחילים, שמרחיב את המדריך של Flux 60-mine-blitz.
הפרויקט מורכב מהשלבים הבאים:
נתחו את אתר התיעוד הנוכחי: מומלץ לבדוק את המידע הקיים ולהגדיר מדריך סגנון (כדי לקבל את המידע הזה) ליצירת מדריכים חדשים.
הגדרת מבנה חדש למידע ולמדריך למתחילים: עובדים עם המנטורים כדי לקבוע את הקטעים החדשים ואת הארגון מחדש של אתר המסמכים. בנוסף, כדאי להגדיר תוכן עניינים למדריך למתחילים, ולהשתמש במדריך Flux 60-mine-blitz כנקודת התחלה ולבנות עליו.
שינוי המבנה של המידע: מעדכנים את האתר לפי התוכנית שהוגדרה בשיתוף עם המנטורים בשלב הקודם.
יוצרים את המדריך לתחילת העבודה: כותבים את הטיוטה הראשונה ובודקים אותה. לקבל משוב מהחונכים. כשהמנחים ואני נחליט שיש לנו גרסה סופית של המסמך, אפרסמם אותו באתר המסמכים.
(אופציונלי) המרת המסמכים הקיימים בצורת קובצי README ל-HTML: אם נותר לי זמן מה לאחר השלמת ארבעת השלבים העיקריים, אוכל להמיר את המדריכים הקיימים שהם קובצי README כדי שניתן יהיה לגשת אליהם בקלות מהאתר.
כדי להשיג את יעד הפרויקט, אעבוד בשיתוף פעולה הדוק עם קהילת Flux כדי להבין את המסמכים הקיימים ולהחליט מהי הגישה הטובה ביותר. גם אני חדש ב-Julia, ואני מאמין שהמידע הזה יעזור לי לקבוע את רמת המידע המתאימה למדריך החדש למתחילים.
אתמקד בכך שהעבודה שלי עוזרת לקהילת Flux ליישם שימושים חדשים. בנוסף, אתמקד בעזרה למשתמשים מנוסים כדי לגלות תרחישים לדוגמה חדשים ולחקור את הפרטים הספציפיים יותר של Flux.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-11-08 (שעון UTC).
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2024-11-08 (שעון UTC)."],[[["This Google Season of Docs project focuses on enhancing the FluxML website's documentation to make it more user-friendly for both beginners and experienced users."],["The project involves restructuring the existing content, creating a new getting started tutorial that expands on the existing 60-minute tutorial, and potentially converting README files to HTML for better accessibility."],["Collaboration with the Flux community is central to this project, ensuring the documentation effectively addresses the needs of its users."],["The primary goal is to simplify onboarding for new Flux users and facilitate deeper exploration of Flux features for experienced users by providing a clear and well-organized documentation structure."]]],["The project focuses on overhauling the FluxML website's documentation. Key actions include auditing existing content, defining a style guide, and restructuring information into new sections. A new, comprehensive \"getting started\" tutorial will be developed, extending the existing Flux 60-minute blitz. The project involves collaborative work with mentors to refine the documentation structure, tutorial content, and website updates. An optional phase involves converting README files to HTML for easier website access. The technical writer will focus on improving onboarding and exploration for users.\n"]]
