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

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

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

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

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

מידע אישי

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

פרטים מקצועיים

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

הצהרת כוונות לפרויקט

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