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

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

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

האם כדאי לך להשתתף בתוכנית 'עונה של תוכנית Docs'?

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

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

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

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

השתתפות ככותב טכני בעונה של תוכנית Docs

שלב החקירה

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

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

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

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

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

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

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

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