דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- ג'נגו
- כתב טכני:
- גביprecious
- שם הפרויקט:
- שכתבו את המדריך ליצירת תכנים ידידותיים למשתמש ולנווט בקלות
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
מופשט
מטרת מדריך התרומות של Django, כמו כל מסמך אחר, היא להדריך משתמשים ותורמים מהקוד הפתוח במקרה הזה, להסביר איך ואיפה הם יכולים לתרום כדי ש-Django יהיה טוב יותר ובר קיימא.
תמיד צריך ליצור תיעוד, במיוחד תיעוד שמשפיע באופן משמעותי על הקהילה וג'נגו עצמו.
המטרה של ג'נגו ב-Google Summer of Docs השנה היא להפוך את המדריך בנושא תרומות פחות מלהיב, נגיש ומזמין את התלמידים לתרום תוכן. זהו מטרה חיונית שהיא מעודדת תורמים, ואני גם אני רוצה להתחיל לתרום למסגרת הנהדרת הזו.
מצב נוכחי
השלב הנוכחי של התיעוד, שניתן למצוא כאן, אינו של מדריך מעשי כי הוא מוצף מדי, לא מובנה מספיק ומוביל פחות הבנה לגבי התרומה של ג'נגו ולא מברך על תורמים חדשים.
יעדי הפרויקט
דנתי בהצעות שלי למסמכים יחד עם המנטור שלי, קרלטון גיבסון בפורום, והוא מאשר שהבעיה תעזור לפתור את הבעיה המאתגרת בתיעוד הנוכחי. הנה המטרות שאני מתכננת להשיג מחדש את מבנה המסמך: שינוי מבנה המסמך הוספת סעיפים/פעולות לביצוע יצירת דפים בודדים לקטעים טריוויאליים כמו בקשה והכנת תכונות תיעוד מופחת וישיר מילון מילים אינדקס פנימי שנוצר בהתאם למדריך החדש כתיבת תיעוד ידידותי יותר וידידותי יותר לחלק את התוכן לשני חלקים עיקריים, לתורמים ולמתקדמים כדי ליצור מסמכים בתאריך קבוע, לתורמים ולמתקדמים לצורך יצירת סטנדרטים וסטנדרטים מתקדמים.
המסמכים הנוכחיים כבר מתמקדים בתורמים מנוסים, ולא נותנים הזדמנות לתורמים חדשים ומתחילים גם בקוד פתוח וגם ב-Django. הנה כמה תכנים נוספים למתחילים: סעיף שמדריך קבוצה שונה של תורמים(כותבים טכניים, מעצבים ומפתחים) דף שמתעד בעיות בטיימר הראשון ובעיות קלות שאפשר לפתור. צריך לכתוב כמה קטעים בתיעוד הנוכחי, לשכתב ולהוסיף אותם לקטע למתחילים. קטעים שמסבירים את הנקודות העיקריות או המילים העיקריות שנעשה בהן שימוש בקטע המתקדם.
ציר הזמן
אני רוצה להציג פירוט של האופן שבו אני רוצה לעבוד על היעד של הפרויקט כפי שצוין למעלה, באמצעות היומן ש-Google סיפקה.
שבוע גיבוש לקהילה( 17 באוגוסט - 13 בספטמבר) יצירת מעורבות רבה יותר עם הקהילה המשך לתרום לתיעוד קבלת הצעות נוספות מתורמים מחקר נוסף על מסמכים עדכניים וכלים ייעודיים שבוע 1 – שבוע 4 התחל בתיעוד קטעים על סמך רמות יצירת קטע תיעוד למתחילים במסמכי תיעוד שבוע 4 עד 6 הכנת קטעים לכתיבה ולסיכום מסמכים חדשים בשבוע 4 עד 6 לכתוב קטעים ודברים לכותבים קיימים באינדקס שבוע 1 – שבוע 4
כלים
Sphinx - הכלי הנוכחי לתיעוד נוכחי. לקריאת המסמכים ב-Docs.
למה דווקא הפרויקט הזה?
אני מאמינה בעקרונות העיקריים של מסמכים ומאמרים שמקיפים את כל האנשים בעולם. חוץ מזה, אני מתה על ג'נגו ועל קוד פתוח באופן כללי. התכוונתי לתרום ל-Django בתור התחלה, ולדעתי זו דרך מושלמת לתרום לכלי המועדף עליי תוך כדי היכרות עם בסיס הקוד כדי שתוכלו לתרום יותר כמפתח(וככותב טכני). יהיה נעים ויפה לעבוד עם ארגון שתואם לדעות שלי והיה כלי נהדר לכל הקריירה שלי.
למה אני האדם המתאים לפרויקט הזה?
לפי החשבונות הבאים אני מאמין/ה שאני האדם הנכון: תרמתי ל-Django על ידי כתיבת מאמרים שיעזרו למתחילים להבין את הרעיון של ג'אנגו. בתור מפתחת שרוצה לתרום ל-Django, הבנתי את הצורך של מפתחים אחרים ואיך לתעד את זה כמו שצריך בשבילם. אני שחקן בקבוצה, ואני אעבוד טוב עם פיקוח פחות או יותר של המנטור שלי, קרלטון גיבסון.