השלב הנוכחי:
המקרים לדוגמה פורסמו. ציר הזמן
בדף הזה מפורטות טיפים לארגונים של קוד פתוח שיעזרו להם להעריך ולבחור את הכותבים הטכניים המתאימים להצעות לפרויקטים שלהם במסגרת Google Season of Docs.
מבוא
ארגונים של קוד פתוח חייבים להעסיק כותב טכני שיעבוד על הפרויקט שהם מציעים. הארגונים צריכים למצוא סופר טכני משלהם. אם אתם כותבים טכניים שרוצים לעבוד עם ארגונים שמשתתפים ב-Google Season of Docs, תוכלו למצוא אותם במאגר GitHub של Google Season of Docs ובערוץ#season-of-docs ב-Slack של Write the Docs.
התחלת התהליך
מומלץ להתחיל בתהליך של חיפוש של כותב טכני ברגע שאתם חושבים שאתם רוצים להשתתף ב-Google Season of Docs.
הערכת כותב טכני
מומלץ לבקש מהכותבים הטכניים שאתם שוקלים לעבוד איתם דוגמאות למסמכים שהם פיתחו בעבר, כדי שתוכלו להעריך את כישורי הכתיבה הטכנית והניסיון שלהם.
ניסיון וכישורים בכתיבה טכנית
בודקים את הניסיון הקודם של הכותבים הטכניים. באופן אידיאלי, לכותב הטכני צריך להיות ניסיון קודם בכתיבת מסמכי עזרה טכניים לתעשיית התוכנה. אחד מהיעדים של Google Season of Docs הוא לתת לכותבים טכניים הזדמנות להשתתף במוצרים שמתמקדים במפתחים. לכן, לא חובה שהכותב יהיה בעל ניסיון בממשקי API, ב-SDK או בפלטפורמות אחרות למפתחים, גם אם הפרויקט שלכם מתמקד בקהל של מפתחים.
התמקד במיומנויות שפה ותקשורת. כדאי להעריך את העבודות הקודמות של הכותבים הטכניים מנקודת המבט הזו. הדבר החשוב ביותר: האם אתם מבינים את מה שכתב האדם? אם אתם רוצים לבצע בדיקה מעמיקה של השפה של הכתיבה הטכנית, כדאי לחפש עקביות בסימני הפיסוק ובניסוח, איות תקין ושפה ברורה. האם הניסוח פשוט או מסובך? האם המשפטים קצרים או שהם נמשכים עד שקשה לעקוב אחריהם?
חשוב לשים לב לעיצוב ולפריסה של המסמך. בודקים את הפריסה הכללית של דוגמאות המסמכים. האם העיצוב לוגי? האם קל להתמצא במסמך או בחבילת המסמכים? האם יש תוכן כפול או פערים בולטים?
איך שוכרים כותב טכני
הארגונים צריכים להעסיק סופר טכני ולמלא את טופס ההוכחה לכך שביצעו את ההעסקה, שמופיע בקישור שבהמשך, עד 22 במאי 2024 בשעה 18:00 (שעון UTC).
שלב הגיוס של סופר טכני הושלם.
חשוב לדון עם הסופר הטכני בנושא תגמול ותזמון תשלומים לפני העסקה. מומלץ לארגונים ליצור לוח זמנים לתשלומים עם הכותבים הטכניים על סמך אבני דרך בפרויקט, כולל תשלום בתחילת הפרויקט. חשוב לזכור את תאריכי התשלומים, שיחולו רק פעמיים במהלך התוכנית, ואת הסכומים כשאתם יוצרים לוח זמנים לתשלומים.
הערה: ארגונים שלא גייסו סופר טכני ושלא שלחו את הטופס להוכחת העסקת סופר טכני עד 22 במאי 2024 בשעה 18:00 (שעון UTC) לא יקבלו את התשלום בתאריך התשלום הראשון.