מדריך כתיבה טכני

השלב הנוכחי:
התוצאות יוכרזו. להסבר על ציר הזמן

מדריך זה מיועד לכותבים טכניים שמעוניינים לעבוד עם ארגונים מקובלים שמשתתפים בתוכנית Google Channel (עונת המסמכים של Google).

האם כדאי לך להשתתף בתוכנית Google Channel of Docs?

השאלות הבאות יעזרו לכם להבין אם אתם מעוניינים לעבוד עם ארגון שניתן לעבוד עליו במסגרת תוכנית Google Channel ב-Google Docs.

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

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

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

השתתפות ככותב טכני בתוכנית Google month of Docs

שלב החקר

הבקשות של הארגון ייסגרו ב-24 במרץ 2023 בשעה 18:00 (שעון UTC). אנחנו ממליצים לכותבים טכניים להתחיל לבדוק פרויקטים אפשריים בהקדם האפשרי. עם זאת, ארגונים יכולים לבחור כותבים טכניים לעבודה בכל שלב לפני 10 במאי 2023 בשעה 18:00 לפי שעון UTC.

  • חיפוש פרויקטים שמעניינים אתכם
    • תוכלו לפנות ישירות לארגונים בקוד פתוח לפי ההוראות שמופיעות בדף התוכנית 'עונת Google' של Docs, או לעיין בעונת Google של מאגר GitHub כדי לחפש ארגונים שהביעו עניין בהשתתפות בעונת Google Docs. ארגונים שעשויים להתעניין בהם גם בערוץ #SEASON-of-docs בסרטון Write the Docs Slack.
    • אפשר לבחור פרויקט בכמה דרכים:
      • בוחרים פרויקט בשפה שאתם מכירים או מתעניינים בה, כמו JavaScript או C.
      • עליכם לבחור פרויקט בטכנולוגיה או בדומיין שמעניינים אתכם, כמו למידת מכונה, מדע פתוח או רובוטיקה.
      • בחרו פרויקט בהתאם לידידותיות של הקהילה! מבלים בפורומי הדיונים שלהם, מעיינים בחשבונות של השותפים ביצירת התוכן ברשתות החברתיות (אם הם מדברים על הפרויקט שלהם) ומעיינים במסמכי התיעוד שלהם, אם יש כאלה.
      • אם יש פרויקט שאתם רוצים לעבוד איתו שלא מופיע ברשימת הפרויקטים, צרו קשר עם הפרויקט הזה ובקשו מהצוות להגיש בקשה.
  • בודקים את דפי ההצעות של הפרויקטים
    • לאחר שיהיו לכם 3-5 פרויקטים אפשריים, בדקו את דף ההצעה של כל פרויקט
    • עליך לשאול שאלות, לתת משוב ולהציע הצעות באמצעות הערוצים הרשומים בפרויקט למשוב ולדיון
  • עליכם לשלוח הצהרת אינטרס ישירות לארגון. בהצהרת העניין תראו איך הייתם להשיג את היעדים שהוגדרו בהצעת הפרויקט של הארגון.
    • משתמשים בתבנית להצהרה על תחומי עניין של Google Channel ב-Docs. קצר יותר הוא טוב יותר!
    • כדי לשלוח את הצהרת העניין, אפשר לפעול לפי ההוראות בדף הרעיונות של הארגון. אם הארגון ציין דרישות מיוחדות, הקפידו להראות שאתם עומדים בהן.
    • שליחת הצהרת העניין שלך מבטאת את הסכמתך לציית לקוד ההתנהגות של הארגון ולקוד ההתנהגות של Google Channel of Docs.

שלב הגשת הבקשה

  • ממתינים להודעה על הארגונים שאושרו ב-Google העונה של Docs:
    • ארגונים שמתקבלים יפנו אליך ישירות אם הם ירצו לעבוד איתך או לדון איתכם בעניין אחר.
    • ארגונים לא מוגבלים לעבודה רק עם כותבים טכניים ששלחו הצהרות עניין עד המועד האחרון להגשת הבקשה לארגון. הם עשויים לבקש הצהרות נוספות על תחומי עניין לאחר קבלת ההצעה. על הארגונים לבחור כותב טכני לפני 10 במאי 2023 בשעה 18:00 לפי שעון UTC.
    • ארגונים לא נדרשים לספק משוב על הצהרות התעניינות שלא הוגשו.

שלב פיתוח הפרויקט

  • עובדים עם הארגון כדי ליצור לוח זמנים, כולל מועדי מסירה ותאריכי יעד.

שלב ההערכה הסופית ומקרה המקרה

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