מבוא

ברוכים הבאים לעונת המסמכים של Docs!

סמל העונה של Docs

עידוד שיתוף פעולה בקוד פתוח עם כותבים טכניים

השלב הנוכחי:
תוכנית 'עונה של 2019' של Docs הסתיימה ב-6 במרץ 2020. אפשר לראות את ציר הזמן.

המטרה של 'העונה של Docs' היא לספק מסגרת עבודה לכותבים טכניים ולפרויקטים של קוד פתוח, לעבודה משותפת לצורך שיפור התיעוד של פרויקט בקוד פתוח. לכותבים טכניים שלא מתמחים בקוד פתוח, התוכנית מספקת הזדמנות לצבור ניסיון לתרום לפרויקטים של קוד פתוח. התוכנית מספקת דרך חדשה לעבוד יחד עבור כותבים טכניים שכבר עובדים בקוד פתוח. העונה של Docs גם נותנת לפרויקטים של קוד פתוח הזדמנות לעודד מעורבות בקרב קהילת הכתיבה הטכנית.

במהלך התוכנית, כותבים טכניים מקדישים כמה חודשים לעבודה בשיתוף פעולה הדוק עם קהילת קוד פתוח. הם מביאים את המומחיות הטכנית שלהם בכתיבה למסמכי הפרויקט, ובו-זמנית לומדים על פרויקט הקוד הפתוח ועל טכנולוגיות חדשות.

הפרויקטים של הקוד הפתוח פועלים עם הכותבים הטכניים כדי לשפר את המסמכים והתהליכים של הפרויקט. יחד הם יכולים לבחור ליצור ערכת מסמכים חדשה, לעצב מחדש את המסמכים הקיימים או לשפר ולתעד את נוהלי התרומה ואת חוויית הקליטה של קהילת הקוד הפתוח.

ביחד, אנחנו מעלים את המודעות הציבורית למסמכי קוד פתוח, לכתיבה טכנית ולאופן שבו אנחנו יכולים לשתף פעולה לטובת הקהילה הגלובלית של קוד פתוח.

איך זה עובד?

זוהי תהליך העבודה הכללי בעונה של תוכנית Docs:

  • ארגוני קוד פתוח מגישים בקשת הצטרפות לארגוני מנטורים בעונת Docs של השנה. הם יכולים לצרף לאפליקציות שלהם רשימה של רעיונות לפרויקטים לתיעוד.

  • כותבים טכניים בודקים את רשימת הארגונים המשתתפים בשירות ובוחרים את הפרויקטים שמעניינים אותם. כותבים טכניים יכולים לפנות לארגונים הרלוונטיים כדי לדון ברעיונות שלהם. לאחר מכן, הכותב הטכני כותב הצעה לפרויקט ומגיש אותה לעונה של Docs.

  • הארגונים מאשרים את הפרויקטים הטכניים של הכתיבה שהם רוצים לחנך.

  • הכותבים הטכניים המקובלים מבלים כמה חודשים בעבודה עם מנטורים מארגוני הקוד הפתוח כדי להשלים את הפרויקטים שלהם.

  • בסיום התוכנית, מנהלי המערכת של התוכנית של Google מכריזים על הפרויקטים שהסתיימו בהצלחה.

בציר הזמן מוצגים הפרטים של השלבים הרלוונטיים והתאריכים העיקריים.

משתתפים ותפקידים

בהמשך מופיעות הקבוצות העיקריות של האנשים שמשתתפים בעונה של Docs והתפקיד של כל קבוצה בתוכנית:

  • אדמינים ארגוניים הם חברים בארגוני הקוד הפתוח המשתתפים, שמשמשים כעונה הראשית של איש הקשר ב-Docs בארגון שלהם. מנהלי הארגון שולחים בקשה להשתתפות בעונה של Docs, מנהלים את המנטורים בארגון, מוודאים שהפרויקטים הטכניים של הכתיבה מתעדכנים, מטפלים בניירת ומנהלים את חלוקת המלגות למנטור. כדאי לעיין במדריך ובתחומי האחריות של האדמין

  • חונכים בקוד פתוח הם חברים בארגוני הקוד הפתוח שמשתתפים בתוכנית, שהתקבלו כמנטורים בעונה החדשה של Docs. המנטורים עובדים בשיתוף פעולה הדוק עם הכותבים הטכניים כדי לעזור להצלחת הפרויקט. קראו את המדריך ואת תחומי האחריות של המנטור.

  • כותבים טכניים הם כותבים טכניים מרחבי העולם שהתקבלו לעונה של Docs ב-Docs השנה. המועמדים צריכים להיות מסוגלים להפגין ניסיון טכני קודם בכתיבה טכנית, על ידי שליחת תיאורי תפקידים ודוגמאות לעבודה. כדאי לעיין במדריך לכתיבה טכנית ובתחומי האחריות.

  • אדמינים של תוכניות של Google הם מנהלי תוכניות ב-Google שמנהלים את העונה של תוכנית Docs.

השלבים הבאים

  • הצטרפו לרשימת הדיוור של הכרזה על אירוע ספציפי ב-season-of-docs-announce כדי להישאר מעודכנים לגבי מועד הפתיחה של אפליקציות ואירועים חשובים אחרים בתוכנית.
  • בדקו את ציר הזמן כדי לראות תאריכים חשובים וציוני דרך חשובים.
  • כדי להתחיל, צריך להירשם כמשתתפים, בין אם אתם כותבים בנושאים טכניים או חברים בפרויקט קוד פתוח.
  • יש לך שאלות? אפשר לקרוא את השאלות הנפוצות.
  • צרו איתנו קשר אם אתם זקוקים לעזרה נוספת או רוצים להצטרף לדיונים.