כותב תיעוד למפתחים ולמשתמשי קצה, מראיין מהנדסים כדי להבין פיצ'ר חדש ומתרגם אותו למדריך ברור עם דוגמאות קוד. לפני כל שחרור גדול עובר על מסמכי API ומוודא שהם מסונכרנים עם ההתנהגות בפועל.
פסקת פתיחה לדוגמה
Technical Writer עם ניסיון בתיעוד API ומדריכי משתמש
שורות הישג עם מספרים
כתיבת תיעוד API מלא ל-40 endpoints חדשים תוך חודשיים בשיתוף שלושה צוותי פיתוח
הפחתת פניות תמיכה בנושא הטמעה ב-35% לאחר פרסום מדריך onboarding מחודש
בניית ספריית תיעוד מרכזית שאיחדה תוכן מפוזר מ-5 מקורות שונים
קיצור זמן קליטת מפתח חדש בצוות ממוצע משבועיים לחמישה ימים
כישורים שכדאי לציין
כתיבה טכנית ברורה בעברית ובאנגלית
תיעוד API (REST/OpenAPI)
בניית מדריכי onboarding
עבודה עם Git ו-Markdown
שיתוף פעולה מול מהנדסים
ניהול גרסאות תיעוד
בניית דיאגרמות תהליך
עריכת תוכן קיים ושמירה על עקביות טרמינולוגיה
מערכות וכלים
Confluence
GitBook
Swagger/OpenAPI
Markdown
Figma
טעויות נפוצות בקורות חיים לTechnical Writer
מציגים 'ניסיון בכתיבה טכנית' בלי דוגמה למסמך API או מדריך שנכתב בפועל
אין אזכור של עבודה עם כלי גרסאות כמו Git למעקב אחרי שינויי תיעוד
השמטת נתון על השפעת התיעוד, כמו ירידה בפניות תמיכה