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