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