איך כותבים מדריך מאפס?
דוגמה: אתה כותב מדריך "כיצד להתקין דלתות".
כתיבת מדריך על פונקציה חשובה בעבודה יכולה להדגים את היכולות שלכם בפני הממונים עליכם. זה מדגים את היכולת שלך להשלים פרויקט בעצמך.
- 1החליטו בנושא שלכם. היו ספציפיים בהיקפם ובטווחם.
- 2החליטו לאיזה קהל אתם כותבים.
- האם אתה כותב מדריך למתחילים או מומחים (או אי שם בין לבין)?
- האם הקהל הולך להיות מעורב בשיעור (באמצעות המדריך) או בלימוד עצמי?
- 3הגדר בדיוק על מה אתה הולך לדבר במדריך.
- דוגמה: אתה כותב מדריך "כיצד להתקין דלתות". חלק אחד עשוי להיות על דלתות הזזה. חלק אחר עשוי להיות על דלתות כניסה. קטע נוסף עשוי להיות על דלתות אחוריות.
- 4החלט על צו הגיוני להציג את המדריך שלך. לא מדובר בסדר פעולות הגיוני. ייתכן שיהיה צורך להציג נושא כלשהו תחילה. יש לדון תחילה במשימות שייכללו בכל חלקי המדריך. אם אתה מרגיש שעל הקורא כבר להיות בעל הכישורים להשלים את המשימה, שקול לתאר את המשימה בנספח.
- 5אם המדריך ישתמש במינוח טכני או בז'רגון, הכינו מילון מונחים. אם אין זה סביר שהקורא כבר יידע את הז'רגון, הציב את מילון המונחים מיד אחרי תוכן העניינים. עדכן את מילון המונחים תוך כדי כתיבת המדריך.
- הגדרות המונחים במילון המונחים צריכות להיות מדויקות ככל האפשר. אם המונח הוא ראשי תיבות, כמו "סקובה", אז הסבירו במלואו שזה אומר " מכשיר נשימה תת-מימי המכיל עצמי " בהגדרה.
דוגמה: אתה כותב מדריך על מחשב כזה וכך. - 6החליטו אילו נושאים אתם זקוקים למחקר נוסף. מדריך לא מדויק הוא מדריך חסר תועלת. השלם את המחקר המקדים שלך לפני תחילת המדריך.
- 7החלט על ארגון עבור כל קטע שאתה הולך לכתוב.
- דוגמה: אתה כותב מדריך על מחשב כזה וכך. יש לך קטע שנקרא "פתרון בעיות". אתה יכול לכתוב חלק ממנו על בעיות שטח דיסק. אתה יכול לכתוב עוד על שימוש מוגזם בזיכרון.
- 8ארגן כל קטע וחתך בסדר הגיוני, תוך צמצום טווח הנושא.
- 9התחל לכתוב! השתמש בארגון שלך כמדריך, אך שנה אותו אם זה לא עובד.
- כתוב תיאורים של משימות שונות.
- כתוב דוגמאות שהקורא יכול לעקוב אחריהן כדי לקבל הדרכה.
- הכן איורים מתאימים. אל תוסיף אותם עד להשלמת המדריך. יש להתאים את האיורים לטקסט.
- שנה איורים כדי לתת רמזים כדי לציין מה המשתמש מחפש.
- דוגמה 1: (מחפש ברשימה ממוספרת) כותב יחבר בעיה למספר "13".
- דוגמא 2: (מיון) סופר היה מגדיל שורת טקסט שאינה בסדר.
- 10אל תעשי כתיבה של מישהו אחר! ערוך הפניה ו / או מדור ציטוטים המפרט ספרים, מדריכים ואנשים שנתנו לך את המידע.
- שום דבר לא הורס את אמינותו של סופר מהר יותר מאשר פלגיאט. יום אחד, מישהו עשוי לצטט את הכתיבה שלך. איך היית מרגיש שמישהו "גונב" לך את העבודה?
אם המדריך ישתמש במינוח טכני או בז'רגון, הכינו מילון מונחים. - 11הוסף איורים מתאימים. התאם אותם למסמך. אל תפחדו להשתמש במרחב לבן.
- 12הגהה, הגהה ושוב הגהה. הגהה צריכה להימשך. רשמו שגיאות או השמטות. לתקן אותם. רשום קטעים של קטעים אחרים מוצאים מבלבלים. שכתב את הקטע כדי להקל על הקריאה. בקש ממגוון אנשים לקרוא את המדריך שלך על מנת להבטיח את התוצאה הטובה ביותר.
- זה הצו שאני ממליץ לך לבצע הגהה ידנית:
- הוכיח את עבודתך, עצמך.
- בקש מהחבר להגהה.
- בקשו ממומחה (בתחום עליו אתם כותבים) להגהה זאת.
- (אם המדריך מיועד לחברה שלך), בקש מהבוס שלך להגיה זאת.
- יש לקרוא אותו טירון.
- מדוע טירון יש לקרוא זאת? המדריך חייב להיות מובן עד לרמת הידע המינימלית שאתה מצפה לקרוא אותו.
- זה הצו שאני ממליץ לך לבצע הגהה ידנית:
- ודא שעמוד השער וכותרת התחתונה בכל עמוד שם לך כמחבר! הדפס עותקים של המדריך לפני הגשתו באופן אלקטרוני. בקש מגיהים לרשום הערות על הדפים. כלול "C" המוקף בסוגריים תחתונה. רוב התוכניות יפרשו את הסימון הזה כזכויות יוצרים ויציבו את הסמל הנכון. הכותרת התחתונה צריכה לקרוא (ג) לפי שמך. זה לא ימנע מהחברה שלך להעתיק אותה, אבל זה יבטיח את תביעתך לסמכות.
הצהרה משפטית תוכן מאמר זה מיועד לידיעתך הכללית ואינו מיועד להוות תחליף למשפט מקצועי או לייעוץ פיננסי. כמו כן, אין הכוונה להסתמך על ידי המשתמשים בקבלת החלטות השקעה כלשהן.
