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

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

המדריך הזה מיועד לכותבים טכניים שרוצים לעבוד עם ארגונים שהתקבלו לתוכנית Google Season of Docs.

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

השאלות האלה יעזרו לכם להבין אם אתם רוצים לעבוד עם ארגון שאושר לתוכנית Google Season of Docs.

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

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

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

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

שלב הניתוח

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

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

שלב הבקשה

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

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

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

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

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