השלב הנוכחי:
תוכנית 'עונת 2020 של Docs' הסתיימה ב-15 במרץ 2021. אפשר לראות
את ציר הזמן.
דף זה מכיל הנחיות לארגוני קוד פתוח להערכת הצעות לפרויקטים של כתיבה טכנית, ולבחירת הפרויקטים שהם רוצים להדריך בעונה של Docs.
מבוא
כותבים טכניים מגישים הצעות לעונה של Docs כדי לעבוד על פרויקט עם ארגון הקוד הפתוח הנבחר שלהם. מנהלי התוכנית של Google מעבירים את ההצעות לארגוני הקוד הפתוח לצורך הערכה ובחירת פרויקטים. לפרטים על השלבים בתהליך, קראו את המדריך לאדמין בארגון.
בדיקת הצעות של כותבים טכניים
כישורי כתיבה וניסיון טכני
בודקים את הניסיון הקודם של הכותב הטכני. ההצעה של הכותב הטכני כוללת מידע על הניסיון האחרון שלו בכתיבה הטכנית. במצב אידיאלי צריך להיות לו ניסיון מוקדם בכתיבת מסמכים טכניים לתעשיית התוכנה. אחת המטרות של עונה של Docs היא לתת לכותבים טכניים את ההזדמנות להשתתף במוצרים שמתמקדים במפתחים. לכן, גם אם הפרויקט שלכם מתמקד בקהל המפתחים, לא חשוב שלכותב תהיה ניסיון בממשקי API, בערכות SDK או בפלטפורמות אחרות למפתחים.
התמקדות במיומנויות שפה ותקשורת. מנקודת מבט זו, מעריכים את ההצעה של הכותב הטכני. והכי חשוב: האם אפשר להבין מה האדם הזה כתב? כמנטור, תפקידכם הוא לעזור לכותב הטכני בתהליכים, בכלים ובקוד של הקוד הפתוח – לא תצטרכו לעבור גם על הטקסט במסמכי התיעוד. אם אתם רוצים לבדוק לעומק את שפת ההצעה, כדאי להקפיד על עקביות בפיסוק ובניסוח, באיות נכון ובשפה ברורה. האם הניסוח פשוט או מורכב? האם המשפטים קצרים או שהם ממשיכים לפעול עד שקשה לעקוב אחריהם?
חשוב לשים לב לעיצוב ולפריסה של המסמכים. כחלק מההצעה שלהם, לכותב הטכני יש אפשרות לספק דוגמאות של מסמכים שהוא פיתח. כדאי לבדוק את הפריסה הכוללת של הדוגמאות למסמכים. האם העיצוב הגיוני? האם קל להתמצא במסמך או במערך התיעוד? האם יש כפילות בתוכן או שהאם יש פערים ברורים?
ההצעה
בודקים שההצעה תואמת לדרישות שלכם. האם ההצעה קשורה לרעיונות כלשהם של הפרויקטים ששלחת לעונה החדשה של Docs? אם הכותב הטכני הציע רעיון חדש, ודאו שההצעה מתאימה לצרכים של פרויקט הקוד הפתוח שלכם ושהאנשים המתאימים יעזרו לכותב הטכני להשיג את יעדי הפרויקט.
הקפידו על התלהבות וביסודיות. האם ההצעה מעידה על כך שהכותב הטכני נלהב מהפרויקט? תוכלו להחליט אם הם הקדישו מחשבה ועבודה להצעה, באמצעות התייעצויות עם הארגון שלכם בשלב המחקר או על ידי הוספת המחשבות שלהם על האופן שבו ניתן להשיג את יעדי הפרויקט.
שאלות נפוצות
איך קובעים כמה פרויקטים לשלוח?
התמקדו בפרויקט אחד או שניים. אם לארגון שלכם יש יכולת לחונכות יותר מכך, תוכלו לשלוח יותר פרטים. בכל פרויקט של כותב טכני צריך לפחות מנטור אחד (עדיף שניים) שמתחייב לחונך רק לאותו הפרויקט.
כאן מוסבר איך פועלת העונה של Docs ב-Docs.
איך אנחנו בוחרים איזו הצעת כתיבה טכנית לקבל?
הקפידו לבחור את ההצעות הכי טובות של כותבים טכניים שקיבלתם. כלומר, תצטרכו לבחור את ההצעות שהכי מתאימות לדרישות שלכם ולהנחיות ההערכה שמפורטות למעלה.
איפה נמצאים הטפסים הנדרשים כדי לשלוח את ההצעות שנבחרו?
עיינו במדריך למנהל המערכת בארגון.