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

השלב הנוכחי:
התוכנית 'עונת התיעוד' של 2021 הסתיימה ב-14 בדצמבר 2021. ציר הזמן

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

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

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

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

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

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

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

שלב הניתוח

מספר הבקשות לארגון נסגר ב-26 במרץ 2021 בשעה 18:00 לפי שעון UTC. מומלץ לכותבים טכניים להתחיל לבדוק פרויקטים אפשריים מוקדם ככל האפשר. עם זאת, ארגונים יכולים לבחור סופרי טכני לעבודה איתם בכל שלב לפני 17 במאי 2021 בשעה 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. ככל שהשם קצר יותר, כך עדיף.
    • שולחים את הצהרת ההתעניינות לפי ההוראות שבדף הרעיונות של הארגון. אם הארגון ציין דרישות מיוחדות, חשוב לציין בבקשה שאתם עומדים בדרישות האלה.
    • שליחת הצהרת ההתעניינות מבטאת את הסכמתך לציית לקוד ההתנהגות של הארגון ולכללי ההתנהגות של תוכנית Docs של הארגון.

שלב הבקשה

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

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

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

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

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