Shirley Yardeni
Technical Writing
& Translations

Shirley Yardeni
Technical Writing
& Translations

כתיבה טכנית בעברית | English Technical Writing | תרגום טכני לעברית | Technical Translations English

מה קורה כשאיש תוכנה/חומרה/יצרן כותב מסמך טכני?

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

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

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

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

מסמך טוב מתייחס לכל משתמש כאילו זו הפעם הראשונה להפעלה

...ואם הכותב הוא כתב טכני מקצועי?

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

ליצירת קשר, לחץ כאן

ליצירת קשר, לחץ כאן

סמלילים בתמונה להמחשת ההוראה הכתובה