כיצד להשתמש במילים פשוטות בכתיבה טכנית?
אחת הדרכים שכתיבה טכנית מקלה על הבנת הדברים היא באמצעות סגנון כתיבה פשוט ופשוט, כולל מילים פשוטות.
כתיבה טכנית נחשבת כצורת תקשורת בכתב הכוללת לפחות אחד משלושת הפריטים הבאים: (1) כתיבה על נושא מאוד ספציפי וטכני (למשל תוצאה של ניתוח לב); (2) לתאר כיצד להשתמש בטכנולוגיה לביצוע התקשורת (למשל אתרים, בלוגים וכו '); או (3) לתעד תהליך או הליך (למשל כיצד להשתמש ב- MS Excel). נניח שכתיבה טכנית היא לקחת נושא מורכב ומסובך ולהקל על ההבנה והפרשנות. אחת הדרכים שכתיבה טכנית מקלה על הבנת הדברים היא באמצעות סגנון כתיבה פשוט ופשוט, כולל מילים פשוטות.
חלק 1 מתוך 1: תכנון מראש
- 1דע מי יהיה הקהל שלך. לפני שתתחיל בפרויקט כתיבה טכנית כלשהו, הדבר הראשון שאתה צריך לשאול את עצמך הוא מי יהיה המשתמש במסמך שלך. האם ישנם יותר מסוג אחד של משתמשים? איזה סוג של ידע וניסיון יהיה למשתמש זה בנושא? מה המשתמש ישתמש במסמך שלי? באיזו תדירות הם יצטרכו להפנות חזרה למסמך שלי? האם המשתמש יבין את הז'רגון הקשור לנושא?
- משתמשים בכתיבה טכנית יכולים לחלק למספר קטגוריות שונות, כל אחד עם הצרכים הספציפיים שלהם: לקוחות, משתמשי קצה, מתקינים, מפתחים, מאמנים ומתאמנים, או תמיכה טכנית.
- סביר להניח שלא תוכלו לכתוב מסמך נפרד לכל משתמש, לכן תצטרכו לקחת בחשבון את הצרכים של כל המשתמשים הפוטנציאליים בעת כתיבה.
- 2פתח את היעדים לכתיבתך. לאחר שהבנתם מי הקהל שלכם, עליכם להבין כיצד המשתמשים הללו ישתמשו במסמך. באופן כללי מטרת המסמך תשתלב באחת משתי קטגוריות: מבוסס משימות או התייחסות. מסמכים מבוססי משימות הם מנקודת מבט של מה שהמשתמש עושה, ואילו מסמכים מבוססי הפניה הם מנקודת מבט של מה שהמוצר עושה.
- דוגמה למסמך מבוסס משימה יכולה להיות הוראות כיצד ליצור אתר ב- Wordpress. במצב זה תעביר את המשתמש בכל השלבים מההתחלה ועד הסוף, ללא קשר למקום שבו השלבים הללו מתרחשים בתוכנת Wordpress.
- דוגמה למסמך מבוסס הפניה יכולה להיות הוראות שימוש עבור נגן Blu-Ray. במצב זה היית מסביר כל חלק במכונה בנפרד - מה כל לחצן, פונקציה, פריט תפריט וכו 'עושה.
- 3התארגנו מראש. תכנון כל תהליך הכתיבה שלך הוא דרך יעילה ואפקטיבית לגשת לפרויקט שלך. גישה טובה כוללת: איסוף המידע, תכנון וארגון המידע, כתיבה, אימות ובדיקה, וביצוע מחדש ושינוי. אמנם גישה זו נראית כאילו יש לה 5 שלבים מסודרים, אך למעשה מדובר בתהליך מעגלי. בכל נקודה בגישה זו יתכן שתצטרך לחזור לשלב קודם.
- איסוף המידע כולל: קריאת כל שביכולתכם בנושא; שימוש במוצר בעצמך; הבנה מה המשתמשים שלך צריכים לדעת על הפריט; לראיין את האנשים שפיתחו את הפריט; השתתפות בפגישות בהן נדון בפירוט בפריט והאזנה לאמור; ומאפשר למומחי הפריטים לספק לך משוב אם טעית במשהו.
- תכנון וארגון המידע כולל: להבין מה בדיוק אתה צריך לכתוב עליו (כלומר מה הם המוצרים שלך); פיתוח לוח זמנים לעבודה שלך; ובדיקת התוכנית שלך עם האנשים הדרושים כדי לוודא שהיא עומדת בציפיות.
- הכתיבה מתבצעת בצורה היעילה ביותר על ידי: יצירת מתאר שלם של המסמך שלך, כולל כל הנושאים שאתה מתכנן לכסות; למעשה לכתוב כל פרק וקטע; וקביעה מתי אין לך מספיק מידע כדי לסיים פרק או קטע מסוים ואתה צריך לחקור יותר.
- אימות ובדיקה הוא המקום בו אתה מוודא שהמסמך שלך אכן מבצע את מה שהוא נועד לעשות, באופן מדויק. התחל בניסיון להשתמש במסמך משלך - האם כל השלבים הגיוניים, האם חסר משהו וכו '. הבא קרא את המסמך עבור פריטים שאינם תוכן כמו דקדוק, איות, פורמט וכו'. לבסוף תצטרך למסור את המסמך שלך ל מומחה אחד או יותר ובקש מהם לעיין בו.
- ביצוע מחדש ושינוי הוא המקום אליו אתה לוקח את כל המשוב שקיבלת, כולל מעצמך, ומעדכן את המסמך שלך בפריטים אלה. ובהתאם לאופן השימוש במסמך, הוא יכול לכלול ביקורות ועדכונים מתמידים לאורך זמן, שכן נעשה שימוש במסמך ונמצאות בעיות.
4- דע מבעוד מועד שזה לא יהיה מושלם. למרבה הצער, רוב הכותבים הטכניים מקבלים תשלום עבור הפקת מסמך במסגרת פרק זמן מוגדר, או תמורת מחיר מוגדר. רוב הסיכויים שאתה עלול למצוא את עצמך זקוק להתפשר על דבר אחד כדי להבטיח שמשהו אחר יכול לקרות. זה אולי נראה כמו רעיון קשה לעקוף את הראש, אבל זו מציאות מצערת של הרבה סביבות עבודה ומצבים.
- הדבר החשוב ביותר שיש לזכור הוא שמסמך טכני צריך - בראש ובראשונה - להיות מדויק.
- על המסמך להיות מלא ככל האפשר. לא יהיו חסרים צעדים העלולים לבלבל משתמש.
- לאחר שביצעת את החלקים 'מדויקים' ו'שלמים ', תוכל לדאוג לגבי הקלדות, עיצוב, טבלאות, רשימות וכו'.
פשוט פירושו גם להשתמש במילים קטנות יותר במידת האפשר, במקום במילים גדולות ומורכבות שלא עוזרות להסביר את העניין.
כותב כך שכולם מבינים
- הימנע מז'רגון וסלנג. בשלב זה עליכם להיות מודעים לחלוטין למי הקהל שלכם, ואם יש להם כבר את המומחיות להבין את הז'רגון הטכני הקשור לנושא שלכם. אם כל הקהל שלך מורכב ממשתמשים מומחים, השימוש בז'רגון לא אמור להוות בעיה. אך אם הקהל שלך מורכב מכל מי שאינו משתמש מומחה, עדיף להימנע משימוש בז'רגון בתדירות האפשרית. לרוב, אם לא לכולם, יש מילים נפוצות בהן ניתן להשתמש במקום. כמה דוגמאות לז'רגון כוללות:
- "סקריפט" - במובן הטכני זה מתייחס לקוד מחשב, אך האדם הממוצע עשוי לחשוב שזה אומר תסריט למחזה או לסרט.
- "ביטול ביטול" - מונח זה משמש הרבה בתוכניות טלוויזיה וסרטי פשע. זה אומר "נושא לא ידוע / לא מזוהה." אבל לאדם הדיוט מונח זה כנראה לא אומר כלום.
- "גילוי נאות" - במובן העסקי, המשמעות היא לבצע מחקר מלא על משהו לפני קבלת ההחלטה. זה אולי לא אומר שום דבר לאדם הדיוט, או שהם עשויים לפרש את המילים בנפרד.
- "אגף שמאל" או "אגף ימין" - מנקודת מבט פוליטית זה מתייחס למישהו שהוא ליברלי או שמרני, אבל הרבה אנשים הדיוטים לא מכירים את המונחים. במקום זאת, כתוב ליברל או שמרני.
- איות קיצורים וראשי תיבות. בעת שימוש בקיצורים, תמיד איות את השם המלא תחילה, ואז שים את הקיצור בסוגריים אחרי התיאור המלא (למשל איגוד הספרייות האירופי (ALA)). בשאר החלקים או הפרקים תוכלו להשתמש בקיצור במקום השם המלא (למשל ALA).
- שים לב שראשי תיבות אינם בהכרח אותו דבר כמו קיצורים. ראשי תיבות הם צורות קצרות באותיות בלבד כמו קיצורים, אך בניגוד לקיצורים, ניתן לבטא את האותיות כמילה. לדוגמה, ALA היה מבטא את כל האות בנפרד כשאומרים אותה, בעוד ש- LAN לא נכתב, זה הופך למילה.
- הגדר מילים או מונחים לא מוכרים. ישנם מונחים מדעיים או טכניים רבים אשר תצטרך להשתמש בהם בכתיבתך, אך יתכן שהם אינם מוכרים לחלק או לקהל שלך. בעת שימוש במילה או במונח שאינו חלק משפת היומיום, הגדירו זאת בפעם הראשונה בה אתם משתמשים בה. אתה יכול להגדיר את זה על ידי הצבת ההגדרה בתוך סוגריים אחרי המונח (למשל לשים את ההגדרה כאן), או ליצור מילון מונחים שמתייחס לכל המסמך. אם תחליט על מילון מונחים, הדגש את המילה או המונח בצורה כזו כדי להתריע בפני הקורא להתייחס למילון המונחים לצורך הגדרתו (למשל מודגש, נטוי, קו תחתון וכו ').
- חלופה למילון מונחים רחב כל המסמכים היא טבלה המגדירה מילים ומונחים חשובים בתחילת כל פרק. משתמשים יקראו את ההגדרות לפני קריאת התוכן. עם ההגדרות הטריות בזכרונם, התוכן יהיה מובן יותר.
- הימנע משימוש בקלישאות, גם אם אתה חושב שרוב הקהל שלך מבין אותן.
- זכרו שפחות זה יותר. כשאתה מנסה להסביר משהו טכני לאדם הממוצע, השתמש בכמה שפחות מילים כדי להעביר את הנקודה שלך. אין צורך להסביר את כל הדברים האחרונים שאתה אומר בפירוט עצום. זכור מיהו הקהל שלך - אם אתה כותב מדריך למשתמש עבור נגן DVD, אינך צריך להסביר כיצד הלוחות בתוך נגן ה- DVD עובדים. אתה רק צריך להסביר מה קורה כשלוחצים על כפתור מסוים. הצעה זו כוללת גם בחירת המספר הנמוך ביותר של מילים הדרושות לנקודה - הימנע מיתירות.
- דוגמה לאמירה מיותרת היא: "איכות המים בנהר אתאבסקה פחתה במאי. ירידה זו התרחשה בגלל הגשמים החזקים החודש. כל המים הנוספים העמיסו את המפעל לטיפול במים של מחוז ילוהד."
- אותה דוגמה שנכתבה ללא יתירות היא: "איכות המים בנהר אתאבסקה פחתה בחודש מרץ מכיוון שגשמים עזים העמיסו את מפעל הטיפול במים ילוהד."
- משפטים לדוגמא (עם מילים מיותרות בסוגריים) הם כדלקמן:
- (כבר קיים
- (בהווה) (זמן)
- (להמשיך) להישאר
- (חלל ריק
- לערבב (יחד)
- לעולם (לפני)
- לצאת לדרך)
- בכלל לא)
- שים את המידע המרכזי בחזית. כשאתה מקפיד על כתיבה טכנית, שים קודם את חלקי המידע החשובים ביותר. לאחר שהמידע המרכזי נאמר, תוכלו לעקוב אחר הסבר מדוע זה קרה, או מה גרם לזה לקרות.
- אל תגיד "למרות חמש פנדלים בתקופות הראשונות והשנייה של המשחק, עליי האדר עדיין הצליחו לנצח", כאשר אתה יכול לומר "עליי האדר ניצחו, למרות חמישה פנדלים בתקופה הראשונה והשנייה."
- הוסף הומור. כתיבה טכנית (ומדעית) אינה ידועה בהומור שלה, וזה לא בהכרח דבר טוב. הוספת מעט הומור, בדיוק במקום הנכון, עוזרת לקורא לשים לב. כתיבה טכנית יבשה, משעממת וחוזרת על עצמה נוטה לאבד את תשומת ליבו של הקורא די מהר. מקום נהדר לשים בו הומור הוא בדוגמאות.
לפני שתתחיל כל פרויקט כתיבה טכנית, הדבר הראשון שאתה צריך לשאול את עצמך הוא מי יהיה המשתמש במסמך שלך.
שימוש במילים פשוטות
- שמור על זה ישר קדימה. כתיבה פשוטה ופשוטה, במיוחד במסמך טכני, מסייעת להבטיח שהקורא לא מבין נכון את הנאמר. פירוש הדבר לשמור על הסברים וכוונות ברורים. כל מה שאתה כותב צריך להיות בעל משמעות או פרשנות אחת בלבד. פשוט פירושו גם להשתמש במילים קטנות יותר במידת האפשר, במקום במילים גדולות ומורכבות שלא עוזרות להסביר את העניין. מילים גדולות ומורכבות יכולות גם לגרום לסופר להיראות יהיר ועלולות לגרום לקורא שלך לאבד עניין.
- דוגמה להוראה לא ברורה היא: "המערכת תפנה שטח אחסון לפי הצורך ב- FIFO), או לוח זמנים מוגדר אחר."
- דוגמה להוראה ברורה היא: "המערכת תמחק תחילה את ההקלטות העתיקות ביותר כאשר תפנה מקום להקלטות חדשות."
- כמה דוגמאות למילים מורכבות לעומת פשוטות הן כדלקמן:
- ניצול לעומת שימוש
- פונקציונליות לעומת תכונה
- להקל לעומת סיבה
- סיים מול סיום
- הנ"ל לעומת המוזכר
- פרטני לעומת פרט
- עד כה לעומת הקודם
- השתמש בקול פעיל. שימוש בקול פעיל פירושו שנושא המשפט (כלומר שם העצם) מבצע פעולה כלשהי, בניגוד לפעולה המתבצעת בנושא (כלומר קול פסיבי). קול פעיל מתייחס גם לאילו סוגי פעלים משתמשים. קול פעיל נוטה להיות קל יותר להבנה בעת קריאה, ונשמע בטוח יותר.
- דרך נוספת לחשוב באילו פעלים אתה משתמש היא לשקול אם צריך להיות לפניהם "להיות", "הוא" "היה", "היו", "היה" ו"היו. " אם נדרשות מילים נוספות אלה, הפועל כנראה כתוב בקול פסיבי ויש לכתוב אותו מחדש.
- קול פסיבי נוטה להיכתב גם כמשהו שקרה בעבר, בעוד שאתה צריך לכתוב כאילו הכל קורה בהווה, כרגע.
- דוגמה לאמירה בקול פסיבי: "האיש ננשך על ידי הכלב."
- דוגמא לאמירה עם קול פעיל: "הכלב נשך את האיש."
- אם אינך בטוח אם מה שכתבת הוא די ישר קדימה, קרא את זה בקול רם לעצמך.
- הימנע משמות עצם מופשטים. שמות עצם מגיעים בשני סוגים - קונקרטי ומופשט. שמות עצם בטון הם פריטים שאתה יכול לחוות בפועל עם חמשת החושים שלך. לדוגמא, אבן, נגן DVD, מנוע, חוט כחול וכו 'שמות עצם מופשטים הם פריטים הקשורים לרגשות, ערכים, איכויות, מושגים וכו'. לדוגמא, רוגע, רוע, כנות, בגרות, כישרון, חוסר אמון, אהבה, מוות, חלומות וכו '. מסמך טכני צריך להיות מנסה להסביר לקורא כיצד לעשות משהו בצורה ישרה וקונקרטית. שמות עצם מופשטים יכולים בסופו של דבר להסיח את דעת הקורא מהנקודה שאתה מנסה להעלות.
- דוגמה למקומות בהם משתמשים בשמות עצומים מופשטים: "האופי הקיים של שפך האפר הוולקני של הר סנט הלנס טופל באמצעות שימוש יישומי ביכולות דוגמנות מחשב."
- דוגמה למקומות בהם משתמשים בשמות עצם קונקרטיים: "עם מחשבי Cray, דגמנו כמה אפר נפרס מהר סנט הלנס."
- היזהר מכינויים. כינויים כמו "זה" ו"זה "יכולים בסופו של דבר לבלבל את הקוראים מכיוון שרוב ההצהרות שאתה כותב יתייחסו לשמות עצם מרובים. בכינוי, באופן כללי, יש משהו שנקרא קדמון. הקדום הוא שם העצם אליו מתייחס הכינוי. לדוגמא: הכלב שלי רדף אחרי המקל והחזיר אותו. המילה 'מקל' היא שם העצם, ו'זה 'הוא הכינוי. הכינוי 'זה' מתייחס ל"מקלות "הקודמים. באופן אידיאלי, עליכם לחזור על שם העצם במידת האפשר (למשל הכלב שלי רדף אחר המקל והחזיר את המקל), או לנסח מחדש את המשפט כך שאין צורך בכינוי (למשל הכלב שלי רדף והחזיר את המקל).
- דוגמה להצהרה שבה משתמשים בכינויים: "צריך לחבר את הצג לצג המחשב, הוא צריך להיות קרוב מספיק בכבל שיגיע אליו." למה הכוונה "זה"? הצג או המחשב?
- דוגמה שבה לא משתמשים בכינויים: "הצג צריך להיות קרוב מספיק למחשב כדי שהכבל יוכל להגיע אליו."
- השתמש בעקביות. כתיבה טכנית יכולה להכיל הרבה מילים שעלולות להיכתב מספר דרכים. לדוגמא, דוא"ל לעומת דואר אלקטרוני. לחלופין, התחבר מול התחברות לעומת כניסה. איזו אפשרות תבחר להשתמש בידך (או מי שמשלם לך), אך ברגע שתבחר באפשרות, השתמש בה באופן עקבי לאורך כל המסמך. מעבר הלוך ושוב בין 'כניסה' ל'כניסה 'יגרום לבלבול אצל הקורא. דברים אחרים שיש לשמור על עקביות הם:
- הפעלת רשימות תבליטים באותו פורמט בכל פעם, ושימוש באותה פיסוק בכל פעם.
- שימוש באותיות תנאים באותה המסמך כולו, והחלטה באילו פריטים יש להשתמש באותיות רישיות.
- החליטו אם תשתמשו בצירים או לא, ואז עמדו בזה.
- החליטו אם לאיית מספרים, או להשתמש רק במספר בפועל. במסמכים טכניים רבים המספרים אפס עד תשע נכתבים בדרך כלל, ואילו כל מספר שהוא ספרה כפולה ומעלה נכתב כמספר.
- החליטו כיצד תשתמשו בעיצוב כמו BOLD, ITALICS ו- UNDERLINE, ושמרו על עקביות.
- היו מדויקים. דיוק בכתיבה טכנית פירושו הימנעות ממונחים מעורפלים שאינם נחוצים בכדי להעביר את נקודתך. מילים כמו 'אינספור', 'כמה', 'בקירוב', 'ענק', 'זעיר' וכו 'אינן מיותרות ברוב המצבים. דוגמאות ספציפיות לשינוי הכתיבה שלך כדי להיות מדויקות יותר הן כדלקמן:
- אל תגיד "יש הרבה חלקי חילוף זמינים שם" כאשר אתה יכול פשוט לומר "חלקי חילוף זמינים."
- אל תגיד "ניכר ריח חזק באמת" כשאפשר לומר "מורגש ריח חריף."
- אל תגיד "שימוש במערכת האבחון המותקנת במערכת הראשית..." כאשר אתה יכול פשוט לומר "שימוש במערכת האבחון..." או "שימוש במערכת האבחון על גבי המערכת הראשית..."
- אם יש מספר ספציפי המשויך למה שאתה מדבר עליו, השתמש במספר בעת התייחסות לאותו פריט, ולא בביטוי ברמה גבוהה. לדוגמה, השתמש ב"יש 10 סיבות אפשריות שזה יכול לקרות: "במקום" יש מספר סיבות אפשריות שזה יכול לקרות: ".
כתיבה פשוטה ופשוטה, במיוחד במסמך טכני, מסייעת להבטיח שהקורא לא מבין נכון את הנאמר.
- באופן אידיאלי כותבים צריכים לשאוף לסביבה נטולת הסחות דעת כשהם כותבים. זה אומר לכבות את הטלפון הסלולרי שלך, לא לבדוק את הדוא"ל שלך, לא לענות לטלפון וכו '. אם אין לך הסחות דעת, ברגע שתתחיל לכתוב אתה תהיה מופתע כמה אתה יכול לעשות!
- מדריך הסגנון של שיקגו נוטה להיות המקור להנחיות הסגנון לסופרים שאינם אקדמיים. שקול לרכוש מנוי מקוון לאתר, או לקנות עותק קשיח של הספר, כך שתמיד תוכל להתייחס אליו.
כשאתה מקפיד על כתיבה טכנית, שים קודם את חלקי המידע החשובים ביותר.
- קריסטה ואן לאן, המדריך למבוא לכתיבה טכנית (לגונה הילס, קליפורניה: XML Press, 20120), פרק 7
- ואן לאן, המדריך למקורב, פרק 8
- ואן לאן, המדריך למקורב, פרק 9
- ואן לאן, המדריך למקורב, פרק 11
- ואן לאן, המדריך למקורב, פרק 18
- ואן לאן, המדריך למקורב, פרק 18
- פיליפ א. לפלנטה, כתיבה טכנית: מדריך מעשי למהנדסים ומדענים (בוקה רטון, פלורידה: CRC Press, 2012), 24-25
- לפלאנטה, כתיבה טכנית, 21
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- לפלאנטה, כתיבה טכנית, 26-27
- לפלאנטה, כתיבה טכנית, 30-31
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- לפלאנטה, כתיבה טכנית, 32
- https://writing.wisc.edu/Handbook/CCS_activevoice.html
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- http://grammar.yourdictionary.com/parts-of-speech/nouns/concrete-noun.html
- http://examples.yourdictionary.com/examples-of-abstract-nouns.html
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- http://web.mit.edu/me-ugoffice/communication/technical-writing.pdf
- http://grammar.ccc.commnet.edu/grammar/pronouns1.htm
- ואן לאן, המדריך למקורב, פרק 18
- לפלאנטה, כתיבה טכנית, 17-20
- http://chicagomanualofstyle.org/home.html
קרא גם: איך לכתוב סיפור אהבה?
תגובות (4)
- אני לומד להפוך את הכתיבה שלי לשלב הבא.
- הטיפ "זה" ו"זה "מבריק. תודה.
- כמובן, זה שימושי.
- אני חדש בכתיבה טכנית והטיפים האלה עזרו מאוד. המידע הפעיל והפסיבי היה מועיל במיוחד!
