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