כתיבה טכנית של ספרי משתמש, ספרי אחזקה, מצגות טכניות, דו"חות טכניים ועוד, היא כתיבה ייעודית שמטרתה להעביר מידע בצורה מדוייקת […]
מבוא – כתיבה הטכנית היא כתיבה ששואפת להעביר מידע בדרך היעילה ביותר. אם מדובר במדריך למשתמש או בספר אחזקה, בדו"ח טכני או במצגת טכנית, תמיד מדובר בהעברת מידע, אם לשם הצגת רעיון טכני או מתקן או מכונה, או לשם לימוד וביצוע הפעלה, תחזוקה ועוד, של מתקן או מכונה.
הכתיבה הטכנית צריכה לגרום לקורא להבין רעיון טכני או ללמד את הקורא איך להשתמש בהתקן או איך להתקין חלק חדש בהתקן. זה מה שנדרש. פחות מזה לא מתקבל. ביותר מזה אין צורך. על כן כתיבה טכנית היא כתיבה ישירה ובלי 'קישקושים' מיותרים והיא מכונה לעתים, 'כתיבה יעילה' או 'כתיבה תכליתית'.
כדי להמחיש מהי כתיבה טכנית, כדאי להשוותה לאחותה, הרחוקה ממנה כמזרח ממערב, הכתיבה הספרותית: כתיבה ספרותית היא כתיבה שאיננה נדרשת ליעילות. ההיפך הוא הנכון, כתיבה ספרותית נדרשת ליציאה מן השגרה, למקוריות, דמיון, רגש, ועוד אלמנטים רבים, חלקם יעילים יותר וחלקם פחות. כתיבה ספרותית איננה דורשת מן הקורא שיבין את כל מה שקרא ובוודאי שאיננה דורשת שייבחן על מה שקרא. היא חווייתית בעיקרה, ואם היא מצליחה ללמד משהו, הרי שמה שהיא מלמדת עשוי להיות דבר מה ערטילאי, שייתכן שהכותב לא התכוון אליו כלל, דבר מה שיהיה שונה מקורא לקורא.
כתיבה טכנית היא ההיפך מכתיבה ספרותית ולפעמים נראה כאילו די בהיגיון בריא או בשכל ישר (common sense) כדי לכתוב מסמך המציג רעיון טכני או פרק המתאר איך משתמשים במכשיר או איך מפרקים חלק במכשיר. במציאות זה איננו כך, ואין צורך לחפש הוכחות לדבר: די לפגוש קוראים מבולבלים, שמקללים את המדריך למשתמש שקיבלו יחד עם רהיט להרכבה עצמית או עם מכשיר די.וי.די. חדש, כדי להבין שכתיבה טכנית היא כתיבה הדורשת יותר מהיגיון.
אם שרטוט החיבורים של הדי.וי.די. למערכת שמע נוספת או לאנטנה, המופיע במדריך למשתמש, איננו ברור דיו, וזה מה שקורה בדרך כלל, נאלץ המשתמש המיואש לקרוא לטכנאי שיחבר את המכשיר. דפי הדרכה המסבירים איך מחברים ארון שנקנה בחנות 'עשה זאת בעצמך' הם חומר טוב לבדיחות אינספור ואפילו לקריקטורות מצחיקות, שמראות שהתקנת הארון לפי ההוראות הניב רהיט עם רגליים שפונות לתקרה.
'הסבר קצר ופשוט' שמופיע בחוברת טובה למשתמש, ושבעזרתו אתה מצליח לחבר נכון את החלקים, איננו חושף כמה מחשבה הושקעה בפשטות הזו וכמה כללים לכתיבה נכונה היו מעורבים בו.
חוברת זו נכתבה במטרה ללמד אנשים טכניים ואנשים שיש להם נטייה טכנית, איך לכתוב מדריכי משתמש וספרי אחזקה. כמו כן מתוארים שלבי הכתיבה והטיוטות של מדריכים טכניים במפעל ואיך מוגשים מתווים לדוגמה.
מטרה נוספת של החוברת היא לתת הנחיות כלליות לכל אותם אנשים שאמורים, במסגרת תפקידם, להגיש מסמכים טכניים שונים, מדו"ח תקלה הנשלח למעבדת התיקון, דרך מצגת טכנית המיועדת ללקוח, או פרוייקט גמר המוגש במסגרת לימודים טכנולוגיים. לצורך זה, החלק האחרון של החוברת מציע מתווים למסמכים טכניים שונים, כגון דו"ח, מצגת, הצעת מחיר והצגת רעיון טכני.
התוכנה שמשמשת לכתיבה הטכנית היא תוכנת Word, שאיננה אידיאלית להוצאה לאור, אבל היא ממלאת תפקיד זה ברוב החברות. ולמרות שהכתב הטכני אמור להכיר את התוכנה היטב, לפי ניסיוני, לעולם לא יכיר אותה כפי שמכירות אותה הכתבניות. לכן, התוצר של מלאכת הכתיבה הטכנית איננו התוצר הסופי. העורך משלים את מלאכת הכתב הטכני והכתבנית 'מגהצת' את הפורמט.
הכללים לכתיבה טכנית שרשמתי כאן אינם סוף פסוק וישנה הלכה לא כתובה ותורה שבעל פה וכן דקויות, שנלמדים כולם תוך כדי כתיבה. רק ניסיון כתיבה לאורך זמן יכול לשדרג כישרון מולד.
ספרון זה נכתב אחרי שצברתי ניסיון של שנים בכתיבה טכנית. אני מקווה שהוא יועיל לכל אותם אנשים שאוהבים לכתוב כתיבה טכנית ולכל אלה שנדרשים לכתוב מסמכים טכניים במסגרת תפקידם.
ראובן שמעיה – :
לידיה
כמה כיף לראות תוצר מוגמר. גם אם ראיתי פרק אחד.
שיהיה בהצלחה.
מציע שתעלי זאת לפייסבוק שלך ותשלחי לכל הגופים שעוסקים בכתיבה טכנית בארץ.