יצירת הצהרת עניין

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

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

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

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

מידע אישי

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

מידע מקצועי

  • קישור לתיק עבודות של דוגמאות כתיבה הנגיש לכולם, או קישורים ספציפיים לדוגמאות של העבודה שלכם.
  • סקירה כללית של הניסיון האחרון שלכם בכתיבה טכנית: ציינו את התפקידים הטכניים האחרונים או את הניסיון התעסוקתי שלכם. אם יש לכם ניסיון בתיעוד קוד פתוח, כדאי לכלול אותו גם כאן. סכם את התפקיד, את תחומי האחריות של התפקיד ואת העבודה שהשלמת. מציינים תאריכים במקרים הרלוונטיים.
  • קישור לקורות החיים או לקורות החיים שלכם (CV).
  • אם הארגון קבע דרישות מסוימות לפרויקט, יש לכלול משפט או שניים שמתארים את העמידה שלכם בדרישות האלה. למשל, "השתתפתי ביותר משישה מסמכים ככותבת טכנית וניהלתי שלושה מסמכים עבור הצוות שלי ב-XYZ Industries ב-2018, ב-2019 וב-2020".
  • (אופציונלי) כל מידע נוסף שרוצים להוסיף. לדוגמה, ההתעניינות שלכם במסמכים טכניים, הסיבה שבגללה אתם רוצים להשתתף בעונה של Docs או ניסיון רלוונטי אחר.

הצהרה לגבי הפרויקט

  • שם הפרויקט. אם דף הפרויקט של הארגון מפרט כמה פרויקטים אפשריים, צריך לוודא ששם הצהרת ההתעניינות משקפת את הפרויקט שעליו רוצים לעבוד. אם אתה מגיש הצהרת עניין לארגון שעדיין לא קבע פרויקטים אפשריים, הכותרת צריכה לסכם את העבודה שאתה מציע. לדוגמה, הכותרת "Create Interactive ProjectX API Documents" היא כותרת טובה יותר מ "מסמכי תיעוד עבור ProjectX".
  • תיאור מפורט.
    • צריך לתאר את הגישה של הארגון לפרויקט בדף ההצעה לפרויקט, כפי שצוין.
    • אומרים איך ההצעה שלכם תפתור את הבעיה או תשיג את היעד שהוגדר על ידי הארגון בדף ההצעה לפרויקט.
    • יש לכלול סיכום של כל הדיונים שהיו לכם עם חברי הארגון על הפרויקט.
    • חשוב לשים לב לשפה ולסגנון של ההצעה. הארגון של הקוד הפתוח עשוי להשתמש בנתונים האלה כגורם להערכת ההצעה שלכם.
  • הצעה לציר הזמן
    • תאר באופן כללי את ציר הזמן ואת שלבי הפרויקט. לדוגמה, תוכלו להקציב שבועיים לאיסוף מידע, ארבעה שבועות לכתיבה, שבועיים לבדיקה ולשינויים ושבוע לפרסום.
    • לכלול ציפיות מפורשות להשתתפות ולמשוב של חברי הפרויקט. לדוגמה, תוכלו להצהיר שציר הזמן שלכם תלוי בקבלת תגובות לשאילתות תוך שלושה ימים.
  • הצעה לתקציב
    • מומלץ שכותבים טכניים יציעו תקציב לפרויקט כולו ולא תעריף לשעה.
    • במידת האפשר, ספק אפשרויות להיקף מצומצם או מוגדל. לדוגמה, אתם יכולים לתת אפשרויות תקציב שונות לתיעוד הוראות הפריסה לשתי פלטפורמות, לארבע או שש פלטפורמות.