השלב הנוכחי:
תוכנית 'עונת 2021' של Docs הסתיימה ב-14 בדצמבר 2021. אפשר לראות
את ציר הזמן.
ריכזנו כאן כמה הנחיות שיעזרו לארגוני קוד פתוח לעבוד ביעילות עם כותבים טכניים.
מציגים את הכותב הטכני לעולם הקוד הפתוח ולקהילה
- הציעו לכותב הטכני 'סיור מודרך' בקהילה שלכם. איפה אפשר לשאול שאלות? לאילו פגישות קבועות הם צריכים להשתתף, או לאילו רשימות תפוצה הם צריכים להצטרף? לאילו חשבונות הם צריכים (GitHub, Discord, Slack)? ודאו שהם מבינים את קוד ההתנהגות של הפרויקט ושהם יודעים איך לדווח על בעיות. חשוב לוודא שהכותב הטכני מבין את הרישיון של הפרויקט, ועומד בדרישות של מעסיקים אחרים בנוגע לחתימה על הסכמי רישיון למכירת רכב (DCO) או על הסכמים אחרים.
- אם אפשר, כדאי להציג בפניהם כמה אנשים באזורי זמן חופפים שיכולים להשיב במהירות לשאלות בנוגע לקהילה או לפרויקט.
- אם אפשר, כדאי לשלוח להם פרויקט מיוחד!
עוזרים לכותבים הטכניים להשתמש בכלים ובתהליכים שב כדי לתרום לפרויקט שלכם
- אם התהליכים שלכם לא מתועדים היטב, הגדירו זמן שבו יסבירו לכותב הטכני על התרומה הראשונה, הבעיה או הבקשה הראשונה ששלח. באילו תבניות או תגים עליהם להשתמש? מי צריך לבדוק את התרומה שלו, ואיך ומתי עליו לבדוק את הביקורות שהוא מספק? אם העבודה שלהם כוללת דוגמאות קוד, איך אפשר לבדוק אותן? מה הם צריכים לדעת לגבי תהליך או הגרסאות של CI/CD?
עזרה לכותב הטכני להבין את הפרויקט ואת המשתמשים בו
- הסבירו את הפרויקט בפירוט כדי שהכותב הטכני יוכל להבין את המוצר היטב. זה יכול לעזור לכותבים הטכניים להרגיש בטוחים יותר ולהתבסס יותר על עצמם בכתיבה שלהם לפרויקט.
- תארו את הצרכים של האנשים שמשתמשים בפרויקט. השתדלו לפרט ככל האפשר – לא רק 'מפתחים' אלא 'מפתחים שיוצרים אתרי אינטרנט' ו'מפתחים שמתכנתים רובוטים תעשייתיים'.
- קשר את הכותב הטכני אל המומחים הרלוונטיים הרלוונטיים. כלומר, המפתחים או שותפים אחרים בפרויקט האחראים על ההיבטים של הפרויקט שלכם, שתעסוק במסמכי התיעוד.
- חשוב לוודא שהכותב הטכני מקבל את הזמן והמשאבים הדרושים מהמומחים לנושא ומכל חבר אחר בקהילה.
אפשר לשאול שאלות!
- יכול להיות שהקהילה או הפרויקט שלכם לא עבדו בעבר עם כותבים טכניים או עם שותפים ביצירת המסמכים. נצל את ההזדמנות ללמוד בזמן שאתה משתף את הידע שלך! בקשו משוב על התהליכים והכלים שלכם — סביר להניח שהכותב הטכני יציג הצעות לשיפור.