איך כותבים דוח טכני?
מטרת תקציר הדו"ח הטכני היא להביא את עיקרי הדו"ח לכ -300 מילים.
מהנדסים, מדענים ואנשי מקצוע בתחום הרפואה צריכים להיות כותבים טובים מדי - ודוחות טכניים מוכיחים זאת! נתוני מתנות דו"ח טכניים טובים וניתוח בנושא מצוין בצורה ברורה, מאוד מאורגנת, יעילה. לפני שתתחיל לכתוב, הגדיר את המסר והקהל שלך, והווה מתאר. לאחר מכן, כתוב את גוף הראשי של הדוח והקיף אותו עם החלקים הדרושים האחרים, בהתאם לפריסה שבחרת.
חלק 1 מתוך 3: תכנון הדוח שלך
- 1קבע את המסר שברצונך להעביר באמצעות הדוח. עשית את המחקר שלך ואספת את הנתונים שלך, אז עכשיו הגיע הזמן לשאול את עצמך מה המשמעות של כל זה. כיצד תגדיר את הבעיה או הנושא אליו אתה מתייחס ואילו מסקנות אתה יכול להסיק על סמך הנתונים והראיות?
- לדוגמה, ייתכן שתרצה להעביר את המסר כי טכניקה חדשה להפקת תרכובת כימית מסוימת היא בטוחה יותר וחסכונית יותר.
- הדוחות הטכניים הטובים ביותר נשארים ברורים וממוקדים לאורך כל הדרך - יש להם מטרה ספציפית ומעבירים את המידע בסדר הגיוני.
- עבוד עם יועצים, מפקחים או עמיתים בכדי לכוונן את המסר ו / או מטרת הדוח שלך. אלה יכולים להשתנות במידה רבה, תלוי אם הדוח מופק למטרות אקדמיות, עסקיות או אחרות.
- 2הגדירו את הקהל שלכם לפני שתתחילו לכתוב. מי יקרא את חוקרי הדו"ח, מנהלי הארגון, הציבור הרחב או מישהו אחר? זה הכרחי שהדוח שלך ייכתב באופן שניתן יהיה להבין בקלות את נתוניו וממצאיו על ידי הקהל המיועד לו.
- אם אחרים בתחום שלך יקראו את הדוח, זה יכול להיות "טכני" יותר בשפה ובפירוט. במקרים רבים, עם זאת, דוחות טכניים מיועדים לאלה שמחוץ לתחום הספציפי שלך. אם כן, צמצם את הז'רגון לקוראים שאינם מומחים.
- שקול לחבר שאיננו מומחה יסתכל על הדוח שלך לאורך כל התהליך כדי לתת לך משוב על נגישותו לקהל רחב.
- 3צור מתווה לעקוב בזמן כתיבתך. דוחות טכניים הם בדרך כלל מובנים מאוד, לרוב עם קטעים עם תוויות ברורות וממוספרים. לכן, די פשוט לשרטט מתאר שמזהה כל מרכיב עיקרי בדוח.
- קבע אילו קטעים מסוימים חייב להיות או עשוי להיות בדוח שלך. התייעץ עם האדם או הארגון שאליו תגיש את הדוח לגבי כל דרישות הפריסה.
אם אחרים בתחום שלך יקראו את הדוח, זה יכול להיות "טכני" יותר בשפה ובפירוט.
חלק 2 מתוך 3: כתיבת גוף הדו"ח העיקרי
- 1צור מבוא יסודי אך ממוקד לדוח. המבוא לדוח טכני מפרט את הבעיה העיקרית או הנפקת כתובות הנייר שלך, ואיך אתה מטפל בה בדוח. עליו להצביע בפני הקורא מדוע הנושא הנדון חשוב, ולקבוע בבירור את יעדי הדו"ח שלך.
- ברוב המקרים, המבוא יהיה ככל הנראה באורך של 1-3 פסקאות.
- בסוף ההקדמה צריך להיות ברור בבירור מה הדו"ח "עושה". היא עשויה לעשות זאת באמצעות הצהרה ישירה ("דוח זה מנתח..."), או על ידי מתן סדרה של שאלות (אשר במקרים מסוימים עשויות להיות מדורגות או ממוספרות) לטיפול.
- 2ספק מידע רקע ו / או סקירת ספרות בחלק הבא. מיד לאחר ההקדמה, התעמקו בנסיבות הבסיסיות סביב הנושא העומד לרשותכם - למשל היסטוריה מהירה של הבעיה ורלוונטיותה כיום, למשל. אם זה היה נושא לוויכוח מתמשך בתחומך, אתה יכול גם להעביר את הקוראים דרך דוגמאות חשובות לעבודות קודמות בנושא.
- בעיקרו של דבר, אתה רוצה שקוראים שעשויים להיות חדשים בנושא ירגישו שיש להם לפחות אחיזה ראשונית בזה לאחר קריאת קטע זה.
- 3עקוב אחר תיאור פרויקט ברור ומפורט. בחלק זה, אתה בעצם אומר לקורא שלך מה בעצם עשית בכדי להתמודד עם הבעיה או הנושא הנדון. ספר להם איזה סוג של בדיקות או ניתוחים עשית, באמצעות אילו שיטות וציוד, וכל פרט אחר רלוונטי.
- אם, למשל, הדוח שלך מתמקד בניסוי מסוים, היה ספציפי לדרך הגיונו, הוקם ונערך.
- לפעמים זה נקרא סעיף "שיטות" מכיוון שאתה מתאר את השיטות המשמשות לביצוע המחקר שלך.
- 4הציגו את הנתונים שלכם ותיארו את המשמעות של הכלים בסעיפים הבאים. עכשיו הגעת לליבו של דוח טכני, שבו אתה פורש ומבהיר את הנתונים שאספת באופן ברור. ברוב המקרים תצטרך לספק מספר רב של נתונים וטבלאות כדי להציג את הנתונים בפועל. אל תסמוך אך ורק עליהם, אם כי השתמש בטקסט בכדי להכניס את הממצאים להקשר המתאים לקהל המיועד שלך.
- זה יכול להיות קשה לקבוע כמה נתונים להציג. מתן מעט מדי יכול להחליש משמעותית את הניתוח ואת הדוח הכללי. מתן יותר מדי, לעומת זאת, יכול להטביע את הקורא בים של שולחנות ודמויות. וודא שאתה מספק את כל הנתונים החיוניים, וטועה בצד המספק קצת יותר מדי אלא אם כן הורה אחרת.
- הציגו את הנתונים בסדר הגיוני, כך שכל טבלה או איור יובילו להבא.
- 5לעגל את הדו"ח עם מסקנה שמתארת את ההקדמה שלך. בדוח טכני, ההקדמה שלך צריכה להעלות את השאלות "הגדולות" והמסקנה שלך צריכה לספק את תשובותיך. אם, למשל, ציינת מספר שאלות ספציפיות במבוא שלך, ענה עליהן באופן ספציפי במסקנה. אחרת, השתמש בו כדי לאסוף את הממצאים שלך לאמירה ברורה ומשכנעת.
- היה מודגש במסקנותיך כפי שהנתונים והניתוחים שלך מאפשרים לך להיות. אל תשתמש במונחים כמו "אולי", "אולי", "יכול" וכן הלאה, כתוב משהו כמו, "הנתונים מראים ש..." עם זאת, אל תסיק מסקנות שאינן נתמכות על ידי הנתונים שלך..
דוח טכני טוב מציג נתונים וניתוחים בנושא מוגדר בצורה ברורה, מסודרת ויעילה.
חלק 3 מתוך 3: הוספת רכיבים בפריסה הנכונה
- 1בדוק אם קיימים הנחיות ספציפיות עם האוניברסיטה שלך, המעסיק וכו '. אמנם קיימת מידה לא מבוטלת של סטנדרטיזציה בכל הנוגע לארגון דוחות טכניים, אך הפריסה המסוימת יכולה להשתנות במידה מסוימת לפי משמעת או גורמים אחרים. הפריסה הבאה, למשל, היא סטנדרטית למדי שעשויה לשמש במקרה הספציפי שלך:
- שער
- תקציר
- תקציר מנהלים
- תוכן עניינים
- רשימת דמויות / רשימת טבלאות
- דוח עיקרי: מבוא; סקירת רקע / ספרות; תיאור פרויקט; נתונים / תיאור הנתונים; סיכום
- תודות
- הפניות
- נספחים
- 2צור עמוד שער פשוט בתחילת הדוח שלך. עמוד השער צריך כמובן לספק את כותרת הדוח ואת שמך, ולעתים קרובות כולל פרטים כמו התאריך והמטרה להגשת הדוח. בדוק אם קיימות הנחיות לפריסת עמוד השער למשמעתך, המחלקה, המעסיק וכו '.
- לשער טיפוסי (ולפריסת הדוח הכוללת), ראה http://mech.utah.edu/~rusmeeha/references/Writing.pdf
- 3ספק סקירה מרוכזת של הדו"ח באופן מופשט. מטרת תקציר הדו"ח הטכני היא להביא את עיקרי הדו"ח לכ -300 מילים. עליכם לספק סקירה מהירה מאוד של מה הדו"ח מכסה וכל מסקנות או המלצות שתספקו בו.
- כתוב את התקציר לאחר שכתבת את הדוח בפועל. אתה רוצה שזה יהיה תיאור מרוכז של מה שכתבת, ולא של מה שאתה מתכוון לכתוב.
- בדוק אם קיימת מגבלת מילים ספציפית עבור תקצירך. גם אם אין, 300 מילים הן מגבלת מילים טובה שאליה כדאי לכוון.
- 4צור סיכום מנהלים שמרכז את הדוח בכ- 90%. סיכומי ההנהלה מקבלים את שמם בשל העובדה שהם מכוונים למנהלים בכירים שככל הנראה לא יספיקו לקרוא את כל הדו"ח. דוח ההנהלה צריך להיות ארוך ומפורט יותר מהתמצית, אך עדיין להיות רק כ -10% מאורך הדוח הראשי.
- סיכום ההנהלה צריך להתמקד בממצאים, במסקנות ו / או בהמלצות שלך, ולאפשר לדוח עצמו להציג את הנתונים, אם כי יש לספק עיקרי נתונים.
- בהתאם למצבך, ייתכן שיהיה עליך לכתוב תקציר, סיכום מנהלים או שניהם.
- 5ערכו תוכן עניינים, רשימת טבלאות ורשימת דמויות. תוכן העניינים אמור לפרק את כל הדו"ח חלק אחר פרק, כך שהקוראים יוכלו לחוש במהירות את הדו"ח כולו ולמצוא כל קטע מסוים. דוחות טכניים הם מונחים נתונים, ובדרך כלל כוללים טבלאות ודמויות רבות, לכן ספק רשימות של כל אחד שמזהה אותם במהירות ויידע לקוראים היכן לאתר אותם.
- בדוק אם קיימות הנחיות עיצוב עבור סעיפים אלה. אם הפורמט נשאר בידיכם, שמרו על דברים פשוטים ופשוטים.
המבוא לדוח טכני מפרט את הבעיה העיקרית או נושא כתובות הנייר שלך, ואיך אתה מטפל בה בדוח. - 6עקוב אחר גוף הדו"ח הראשי עם קטע אישורים. בעוד שמדורי הכרה בספרים או סוגים אחרים של עבודות מחקר מודים לעיתים קרובות לחברים ובני משפחה, בדוחות הטכניים הם בדרך כלל מתמקדים בהזכרת מי שעזר ישירות להקל על יצירת הדו"ח. בעיקרון, יש להכיר בסעיף זה לכל אדם או קבוצה שתמכו בעבודתך בתפקיד מקצועי (כולל כלכלית, כגון באמצעות מענקים).
- חלק זה בדרך כלל מריץ 1-2 פסקאות, ועוקב אחר פורמט פשוט למדי "הכותב רוצה להודות...".
- 7כלול ציטוטים בסעיף הפניות, תוך שימוש בפורמט עקבי. צור ציטוט לכל מקור שממנו אתה מצטט או מתייחס אליו בגוף הראשי של הדוח. אם לא תקבל פורמט ציטוט ספציפי לעקוב (למשל, פורמט APA או MLA), בחר אחד ועקוב אחריו בעקביות לאורך כל החלק הזה והדוח כולו.
- במקרים מסוימים, אתה עשוי גם להיות צפוי לספק רשימת עבודות שהתייעצת בהם אך לא הובאת במיוחד בעבודה. התייעץ עם המחלקה, הארגון, הפרט וכו 'הרלוונטי, אם אינך בטוח.
- 8השתמש בנספחים כדי לספק מידע שימושי אך לא חיוני. אם, למשל, יש לך הרבה מאוד נתונים גולמיים שאינם כשלעצמם חיוניים לדוח, אך בכל זאת מאירים, כלול אותם בנספח אחד או יותר. לעולם אל תשים שום דבר שנראה לך חיוני לדוח בנספח - מצא לו מקום בגוף העבודה הראשי.
- השתמש בפורמט עקבי וקל לניווט בעת יצירת נספחים. הם לא נועדו להיות השלכת קטעי מידע או מידע אקראיים.
קרא גם: איך לכתוב סיפור אהבה?
תגובות (1)
- המאמר הזה עוזר לי מאוד. אני יכול להשיג ציונים טובים יותר במטלה שלי על ידי ביצוע השיטה לעיל.
