mc.Cotvim קורס כתיבה טכנית נכונה

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

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

בדרך כלל, אם תראו ספר המערכת, תשקיעו המון מאמץ בעיקר בניתוח תוכן העניינים ואחרי חמש דקות תתייאשו תוך מלמול "איזה ספר... אי אפשר להבין פה כלום, רק סיבך אותי יותר".

אז למה באמת יש למסמכים הטכניים שם של ניירת שתורמת בעיקר לסוחרי העץ ויצרני הדפים? הרבה פעמים יכול להיות ספר של מערכת מסקרנת שעיון של 5 דקות בו עלול לגרום לך הרהורים של לעזוב את התחום, או "איך הצליחו לשעמם אותי בתיאור של מערכת כל כך מעניינת"?

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

יש תשובות טיפה יותר מורכבות מהתשובה הפשוטה שניתנה קודם. חלק מהתשובות, כמו גם דרכים אלטרנטיביות להתייחסות לתחום נמצאים בקורס "הרציונל והנראטיב הטכני".    

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

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

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

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

נראטיב בכתיבת מסמכים טכניים – הנראטיב (או "החוט המקשר") הוא הגורם השני בחשיבותו במסמכים טכניים ולכן מתחילים לחפש אותו רק כשהרציונל הובהר לחלוטין. נסו לדמיין רומן שדן בנושא מסויים או תוקף בעייה מסויימת (להלן רציונל) אך נטול עלילה (להלן נראטיב)...דמיינתם? עברתם את עמוד 17? כנראה שלא. מה שלא יעבוד על המח שלכם בקריאה אמנתותית, על אחת כמה וכמה לא יעבוד בקריאה טכנית.

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

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

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

ההיכרות עם התקנים והמפרטים השונים מקלה לפעמים על מציאת הנראטיב המתאים למסמך, אך פעמים רבות חייבות להתקבל החלטות בתחומים אפורים להם לא נותנים התקנים והמפרטים מענה ושיכולות להיות משמעותיות למבנהו האורגני של המסמך. נושא המינונים למשל הוא דוגמא להחלטות מסוג זה: לאיזה עומק לרדת בתיאור מבלי להפוך למסורבל? באיזה ענפים שבעץ מוצר (או מבנה) להתמקד לעומת ענפים הניתנים לרפרוף? איזה תיאורי טכנולוגיות גנריות חייבים לקבל ביטוי ובאיזה היקפים? איזה נוהל צריך להישאר תוך מפעלי ואיזה חובה שיבוצע גם על ידי הלקוח? איך לתרגם את הקונספט התפעולי / תחזוקתי / ניהולי / ארגוני לנהלי המעשה שהוחלט שיוכנסו למסמך. כל אלה ושאלות רבות אחרות חייבות להשתקף במציאת הנראטיב הנכון למסמך אותו כותבים, ומערכי שיקולים לדוגמא יועברו ויומחשו בקורס זה.  

(מכאן לא כל אחד חייב לקרוא ומי שרוצה יכול להזמין כבר בשלב זה ואף אחד לא יכעס עליו. הסעיף ממשיך בהמחשה של מושג הנראטיב הטכני, שממילא יועבר גם בקורס.) 

בעבר פיתחתי מבחן לנראטיב אופטימלי שבבסיסו עומד עיקרון הקונטקסט (עיקרון ההקשר) -  המבחן הוא פשוט אך קצת סיזיפי: לוקחים סעיף (או מקטע) מסויים ממסמך ובודקים אם קיימים עבור כל התכנים שבסעיף כל ההקשרים הנדרשים בשאר חלקי המסמך לפי הדוגמא הבאה:

למשל, ניקח רכיב מסויים שמתואר במעגל מסויים המקיף את ההיבטים הבאים: 

אופני הפעולה שלו ומשמעותם במעגל בפרט ובמערכת בכלל.

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

כניסות ויציאות של אותות אליו וממנו.

אספקות מתחים אליו וממנו.

תוכנות הצרובות ברכיב.

גיבויים לפעולתו של רכיב זה.   

עכשיו ננסה לבחון את העמידה של הסעיף הנ"ל במבחן הקונטקסט: 

האם הרכיב הנ"ל הוזכר בתיאור אופן הפעולה של המעגל בו הוא מורכב?

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

האם כל האותות הנכנסים אליו תוארו גם ביציאתם אליו וכל האותות היוצאים ממנו מתוארים גם כנכנסים לרכיבים אחרים?

האם בתיאור הרכיב שמשמש לו מקור מתח הוא מוזכר (גם אם ברמה כללית של משפחות רכיבים)? האם בתיאור רכיבים להם הוא מקור מתח הוא מוזכר?

האם הרכיב מוזכר בפרק הדן בצריבת רכיבים כולל אמצעי צריבתו?

האם תיאור המסלול המגבה את פעולת הרכיב הנ"ל מזכיר את קיומו? 

מבחן הקונטקס משמש כ"תעודת ביטוח" שסעיפים ומקטעים לא יהיו באוויר (משמע - לא נחוצים) ושישתלבו באופן אורגני עם שאר חלקי המסמך. סעיפים או מקטעים שלא עוברים את מבחן הקונטקסט לפחות ב 75% או שמוסרים מהמסמך או שגוררים הוספה של החלקים החסרים בו, כמובן בהתאם לרמת החשיבות של התוכן.     

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

הקורס משלב תרגול מעשי בהיקף של 40% ודורש ידע בסיסי ביותר בתוכנות Office בעברית ואנגלית.