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