דף זה תורגם על ידי Cloud Translation API.

עבודה עם כותב/ת טכני/ת

השלב הנוכחי:
התוכנית 'עונת התיעוד' של 2021 הסתיימה ב-14 בדצמבר 2021. ציר הזמן

ריכזנו כאן כמה הנחיות שיעזרו לארגונים של קוד פתוח לעבוד ביעילות עם סופרים טכניים.

כדאי להעניק לכותב הטכני 'סיור מודרך' בקהילה שלכם. איפה הם יכולים לשאול שאלות? באילו פגישות קבועות הם צריכים להשתתף או לאילו רשימות תפוצה הם צריכים להצטרף? אילו חשבונות הם צריכים (Github, ‏ Discord, ‏ Slack)? חשוב לוודא שהם מבינים את קוד ההתנהגות של הפרויקט וכי הם יודעים איך לדווח על בעיות. חשוב לוודא שהכותב הטכני מבין את הרישיון של הפרויקט ועומדים בדרישות של מעסיקים אחרים בנוגע לחתימה על הסכמי CLA, הסכמי DCOs או הסכמים אחרים.
אם אפשר, כדאי להציג להם כמה אנשים באזורי זמן חופפים שיכולים לענות במהירות על שאלות לגבי הקהילה או הפרויקט.
אם יש לכם אפשרות, שלחו להם מזכרת מהפרויקט.

אם התהליכים שלכם לא מתועדים היטב, כדאי לקבוע מועד להדרכה של הכותבים הטכניים לגבי התרומה, הבעיה או בקשת המשיכה הראשונה שלהם. באילו תבניות או תגים כדאי להשתמש? מי צריך לבדוק את התרומה שלו, ואיך ומתי צריך לבצע מעקב אחרי הבדיקות? אם העבודה כוללת דוגמאות קוד, איך אפשר לבדוק אותן? מה הם צריכים לדעת על תהליך ה-CI/CD או על הגרסאות שלכם?

כדאי להסביר את הפרויקט בפירוט כדי שהכותב הטכני יקבל הבנה מושגית מוצקה של המוצר. כך הכותבים הטכניים יוכלו להרגיש בטוחים יותר ולכתוב בצורה מקצועית יותר בפרויקט.
תארו את הצרכים של האנשים שמשתמשים בפרויקט. חשוב להיות ספציפיים ככל האפשר – לא רק 'מפתחים', אלא 'מפתחים שיוצרים אתרים' ו'מפתחים שכותבים תוכנות לרובוטים תעשייתיים'.
מקשרים את הכותבים הטכניים עם המומחים הנדרשים בתחום. כלומר, המפתחים או שותפי הפרויקט האחרים שאחראים על ההיבטים של הפרויקט שיהיו במסמכי התיעוד.
חשוב לוודא שהכותב הטכני מקבל את הזמן והמשאבים שהוא צריך מהמומחים בנושא ומכל חברי הקהילה האחרים.

יכול להיות שהקהילה או הפרויקט שלכם לא עבדו בעבר עם סופרים טכניים או עם שותפים ליצירת מסמכי עזרה. כדאי לנצל את ההזדמנות ללמוד בזמן שאתם משתפים את הידע שלכם. בקשו משוב על התהליכים והכלים שלכם – סביר להניח שלכותב הטכני יהיו כמה הצעות לשיפור.