כתיבה טכנית מעבירה מידע טכני על מיומנות או מוצר לקוראים. הוא נפוץ בתחומים טכניים ותעסוקתיים. ככותב טכני, לעתים קרובות אתה כותב מסמכים כמו מדריכים למשתמש, תיעוד ממשק תכנות יישומים (API) ומדריכי תיקון ומוצר.
כמו נישות כתיבה אחרות, לכתיבה טכנית יש הנחיות ספציפיות לנישה. ביצוע הנחיות אלה יעזור לך לכתוב מסמכים מובנים היטב ולמטב את האופן שבו הקוראים מבינים את עבודתך. הנה כמה כללים שכדאי לעקוב אחריהם כדי להפוך לסופר טכני טוב.
1. הגדר את הקהל שלך
ניתוח קהל הוא גורם הכרחי במסמך טכני טוב. הכרת הקהל שלך עוזרת לך לקבוע את סוג המידע לכתוב עליו, כיצד עליך לבנות אותו ואת הטכניות של השפה שלך. ישנם ארבעה קהלים עיקריים לכתיבה טכנית: מנהלים, מומחים, טכנאים ולא מומחים.
מנהלים הם אנשים שמממנים את המוצר ומקבלים את ההחלטות הפוליטיות, המנהליות והכלכליות השולטות בו. טכנאים הם האנשים שבונים, מפעילים ומתקנים מוצרים אלה. מומחים מעצבים, בודקים ויודעים הכל על המוצר, בעוד שאינם מומחים הם משתמשי הקצה של המוצרים. עליך להתחשב בקהל שלך כדי לקבוע את הטון וסגנון הכתיבה הטובים ביותר לשימוש.
2. זהה את הצרכים של הקהל שלך
מלבד היכרות והגדרת הקהל שלך, חשוב שתבין את המטרות, האינטרסים והצרכים שלו. השלמת ניתוח הקהל שלך היא המפתח בהכנת מסמכים, מכיוון שאתה פחות סביר שתכתוב ללא שיהוקים ותכיר היטב את צרכי הקהל שלך.
כדי לבצע ניתוח קהל מעוגל היטב, עליך לשקול את הרקע של הקהל שלך, את הידע הקיים לגביו המוצר, הניסיון, הצרכים, תחומי העניין, המאפיינים הדמוגרפיים, העדפות התרבות והתקשורת, וכן מטרות. מידע זה יסייע לך להציג את הרעיונות שלך בצורה היעילה והיעילה ביותר.
3. דע את מגבלת הידע של הקהל שלך
כטכניקה של ניתוח קהל, אתה יכול להשתמש בסקרים ושאלונים כדי לדעת את גבול הידע של הקהל שלך. אתה יכול גם לקבל דעות פופולריות וסטריאוטיפים, ניסיון אישי, סיעור מוחות ומשוב קהל, ממחלקת השיווק.
אם תנצלו נכון את הכלים המפורטים למעלה, תדעו עד כמה קהל היעד שלכם מבין את המידע שאתם מתכוונים להעביר. מידע זה יקבע במידה רבה את המבנה, הגבולות והיקפו של המסמך שלך, ויעניק לך תחושת כיוון.
4. שמור על השפה שלך פשוטה
כתיבה טכנית אמורה להציג נושא מסובך מדי. זה עושה זאת באמצעות מדריך סגנון כתיבה פשוט. עליך לוודא שהקורא הממוצע יוכל להבין בקלות את הכתיבה שלך.
עם זאת, עליך לשים לב שהבנת הקהל שלך היא גם מפתח לסגנון השפה שאתה בוחר. למשל, ז'רגון מקצועי במסמך על ממשקי תכנות יישומים (API) עשוי להתאים לטכנאים אך לא למשתמשי קצה. כתוצאה מכך, עליך להשתמש בשפה קלה להבנה כדי לסייע בהבנת הקהל. אולי תרצה גם ללמוד כיצד להשתמש בכלי כמו Microsoft Editor כדי לבדוק את העבודה שלך ולוודא שהכתיבה נכונה.
5. השתמש בקווי מתאר
קווי מתאר נותנים לקוראים שלך מושג למה לצפות במסמך. מסמך ללא קווי מתאר מציף את הקוראים, שכן הוא מאלץ אותם לקרוא את כל הטקסט כאשר הם מעוניינים לרכוש ידע ספציפי בלבד.
ככותב טכני, תיווי המסמך שלך נותן לך גם תחושת כיוון בעת הכתיבה. זה שומר אותך על המסלול ומבטיח שלא תפספס או תתעריך נקודות רלוונטיות. בנוסף, זה משפר את מבנה המסמך שלך ומשמש כמשוב על מה שאתה מתכוון לכסות.
6. השתמש בגרפיקה היכן שצריך
תשומת הלב של רוב הקוראים נמשכת באופן טבעי לגרפיקה בהשוואה לטקסט. במסמכים טכניים, גרפיקה מתאימה יכולה לשפר את הבנת הקוראים את הטקסט על ידי הצגת מידע ברור ומודגש.
עם זאת, ככותב טכני, עליך להיזהר משימוש בגרפיקה לקישוט מסמכים. טבלאות, גרפים, תרשימים, תצלומים ואיורים הם גרפיקה נפוצה, והם יכולים לשפר את המבנה הכללי של המסמך ולפנות לקוראים. עם זאת, אם אתה חדש ב-Google Docs, הנה כיצד ליצור ולערוך טבלאות ב-Google Docs.
7. עניין את הקוראים שלך
למרות שאולי אתה מנסה להעביר מידע טכני לקוראים שלך, חשוב שתשתף גם אותם. כל מסמך טכני מתמקד בקורא ויש לכתוב אותו לפי טעמו של הקורא ולא הכותב. הסקרנות האינטלקטואלית של הקורא שלך חייבת להיות מרוצה כדי שהמסמך שלך יהיה שימושי.
אתה יכול למשוך את הקורא שלך באופן פעיל על ידי כתיבה כדי להביע, לא להרשים, ולהגיע ישר לנקודה. הימנע מקיצורים וז'רגון, השתמש בהרבה שטח לבן כדי לשפר את המצגת החזותית, והשתמש בכותרות כדי להנחות את הקורא שלך.
8. אל תפנה למידע רגיש לזמן
הימנעות מהפניות למידע רגיש לזמן, במיוחד אלה של תקופה דומה, היא תמיד עדיפה. בטוח וחכם יותר להשתמש בניתוח שעמד במבחן הזמן, מה שהופך אותו לירוק עד ומתאים תמיד למי שיקרא את המסמך שלך בעתיד.
עליך גם לשים לב שצירוף שנים ספציפיות, כמו "2019", כדי להדגיש את דבריך עשוי להפחית את התועלת של המסמך שלך לאורך זמן, למעט מקרים ספציפיים. אתה יכול למנוע זאת על ידי שימוש בטווח זמן רחב יותר כמו "בשבע השנים האחרונות", ובכך לתת לעבודה שלך רמת אמינות.
9. השתמש בדוגמאות רלוונטיות
בעת כתיבת מסמך טכני, השתמש במופעים חיים כדי להדגיש את הנקודות שלך. מכיוון שהקהל שלך קורא את הכתיבה שלך כדי לרכוש מיומנות, לפתור בעיה או ללמוד כמה קווים מנחים, עליך לספק להם דוגמאות מעשיות ומתייחסות.
דוגמאות אלה משפרות את קריאות העבודה שלך ומעבירות מידע מורכב לקורא שלך, ומספקות הקשר למוצרים ולתהליכים. בדרך זו, סביר יותר שהם ישתמשו במוצרים באופן מכוון ובטוח.
10. קבל סקירה של צד שלישי לפני הפרסום
מסמך טכני צריך תמיד לעבור תהליך שיתופי הכולל את הכותב והמבקר. סקירה של צד שלישי עוזרת ליצור מסמך ממוקד קהל, נטול שגיאות ומשפיע.
כמחבר המקורי של המסמך, ייתכן שכתבת טיוטות רבות לפני יצירת המסמך הסופי. עם זאת, לא משנה כמה טוב המסמך שלך נראה, אל תסתמך על השכל שלך בלבד.
הפוך לסופר טכני מקצועי היום
הבנת הכללים החיוניים המנחים את הכתיבה הטכנית תגרום לך להיות מיומן יותר ומבוקש יותר. ארגונים רבים יודעים כמה חשוב שהמוצרים או השירותים שלהם ישווקו היטב למשתמשי הקצה, ולעזור להם להשיג זאת היא המטרה שלך ככותב טכני.
