תוֹכֶן

• לדרוך
• חלק 1 מתוך 4: תכנון מדריך הבעלים שלך
• חלק 2 מתוך 4: הטמע מידע חיוני
• חלק 3 מתוך 4: תיאור תחזוקת המוצר
• חלק 4 מתוך 4: כתוב מדריך קריא
• טיפים

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

לדרוך

חלק 1 מתוך 4: תכנון מדריך הבעלים שלך

1. בצע ניתוח משתמשים. יש לכתוב את מדריך המשתמש למשתמשים - אלו שיקנו את המוצר או השירות שלך ויקראו את הוראות השימוש. ניתוח משתמשים יגיד לך מי יהיה קהל היעד העיקרי שלך או ידריך אותך בכתיבת הטקסט.
   • שוחח עם אנשים שישתמשו במכשיר שלך. מציעים למשתמשי הבדיקה אבות טיפוס של המכשיר וטיוטת הוראות שימוש בתנאים מבוקרים. בקש ממשתמשי הבדיקה הללו משוב על דברים שאינם ברורים או מבלבלים במדריך למשתמש ובצע שינויים במדריך למשתמש שלך על סמך משוב זה.
   • לעולם אינך יכול לספק את כל הקהל שלך; כתוב את המדריך המותאם לקהל היעד או לקהל הגדול ביותר.
   • שקול גיל, בריאות (האם יש להם מחלות, לקויות למידה או לקויות?) ורמת ההשכלה של הקהל לקביעת הגישה הטובה ביותר לכתיבת המדריך למשתמש.
2. תיאום עיצוב המדריך למשתמש. אם היית חלק מהצוות שעזר בתכנון ופיתוח המכשיר או המוצר, זה יכול להיות קשה להתבונן באופן אובייקטיבי על המוצר כדי להסביר כיצד הוא עובד. לכן עליך לפנות לקבלת ייעוץ של כותב (רצוי מישהו עם ניסיון בכתיבת הוראות) ומעצב גרפי שיעזור לך להכין את הוראות השימוש. אתה יכול לבחור אנשים אלה באמצעות ייעוץ חיצוני או מחברה או ארגון משלך.
3. בצע ניתוח משימות. ניתוח תפקידים הוא תהליך הזיהוי והארגון של הצעדים הנדרשים לשימוש במכשיר. ניתוח עבודות מעמיק מזהה את החומרים והציוד (כגון סוללות, תרופות או מוצרים אחרים המסופקים על ידי המשתמש) הנדרשים עבור כל שלב, כמו גם את הפעולות, השגיאות וייעוץ לפתרון בעיות שכל שלב עשוי לדרוש.
   • אם יש לך מוצר שיכול לבצע משימות או משימות משנה שונות, עליך לבצע ניתוח משימות עבור כל משימה. לדוגמא: ברכב תוכלו לצפור, לחגור את עצמכם ולהדליק או לכבות את הפנסים. ערוך ניתוח משרות לכל אחד מאלה, במידת הצורך.
4. וודא שהמוצר שלך עומד בדרישות התיוג והרשאת השיווק. דרישות אלו מבטיחות כי מוצרים מיוצרים תוך התחשבות בבטיחות המשתמש וכי חשיפת המשתמש לתנאים מסוכנים, כגון קרינה והחשמל, מוגבלת. מודעות צריכות לציין בבירור את המטרה ואת הנחיות ההפעלה הבסיסיות של מוצר, ועליך להשתמש במשאבים אלה בעת כתיבת מדריך הבעלים שלך.
   • כדי שמדריך המשתמש של המוצר יעיל, עליו להיות כתוב בהתאם לתוויות המודבקות ישירות למוצר.
   • ודא שהמכשיר שלך מורשה רשמית למכירה לפני כתיבת המדריך למשתמש.
5. החלט על פריסת המדריך שלך. ישנן מספר דרכים חשובות בהן ניתן לייעל את המדריך שלך. עליך לשים כותרת מודגשת בתחילת כל קטע עם כל מילה באותיות גדולות. לדוגמה, "הגדר את המכשיר שלך", "הפעל את המכשיר שלך" ו"פתרון בעיות "יכולות להיות כותרות קטע מודגשות.
   • דרך נוספת לייעל את המדריך שלך היא להשתמש בשתי עמודות, אחת מימין עם טקסט והשנייה ממש משמאל לטקסט, עם תבליטים, מספרים או סמלים קטנים, כגון סימני אזהרה או סימני קריאה אדומים.
   • המדריך עשוי להיות מורכב בעיקר מתמונות עם טקסט כלשהו מתחת לכל תמונה כדי להסביר את המכשיר, או שמדובר בעיקר בטקסט עם כמה תמונות נלוות בלבד. אתה יכול גם להשתמש בתרשים זרימה כדי להדריך את המשתמש. חשוב על המוצר שלך ואיך כל שיטה יכולה לעזור לך לכתוב את המדריך שלך. עם זאת, הימנע מערבוב פריסות שונות בתוך מדריך אחד. בחר אחד ותישאר איתו.

חלק 2 מתוך 4: הטמע מידע חיוני

1. ארגן את המדריך באופן הגיוני. יש לבנות את המדריך באופן שהמשתמש יפיק ממנו את התועלת הרבה ביותר. חלק את המדריך לפרקים או סעיפים הגיוניים לשימוש במוצר וכולל תוכן עניינים בחלק הקדמי של המדריך, כך שניתן למצוא כל חלק במהירות.
   • תוכן עניינים נחוץ במיוחד עבור מדריכים ארוכים יותר.
   • מילון מונחים או אינדקס הם הכרחיים אם ישנם מונחים רבים להסביר כי הקהל שלך אולי לא מכיר. עם זאת, מילון מונחים אינו מומלץ; הבחירה הטובה ביותר היא להסביר מונחים מבלבלים בטקסט המדריך עצמו. אם תבחר לכלול מילון מונחים, הצב אותו בחלק הקדמי של המדריך, ממש אחרי תוכן העניינים.
   • רשימת טבלאות או דמויות נחוצה רק אם ישנם יותר מכמה טבלאות או דמויות במדריך.
   • יש צורך בנספח לדברים שיש להסבירם אך לא ניתן להסבירם במקומות אחרים במדריך, מכיוון שהוא ישבש את הזרימה והמיקוד.
2. כלול אזהרות הכרחיות. האזהרות הכלליות או המידע הזהיר צריכים לספק מידע על סכנות פוטנציאליות הנגרמות כתוצאה משימוש לא נכון במוצר, כולל מוות או פציעה קשה. יש למקם את האזהרות בחלק הקדמי ביותר של המדריך, אחרי העמוד הראשון, כדי שהמשתמש יראה אותן תחילה. יש לכלול אזהרות ספציפיות בטקסט המדריך ממש אחרי או רגע לפני שמוצע שלב שעלול להיות מסוכן.
   • לדוגמא, אזהרה כללית למכשיר חשמלי יכולה להיות לא להשתמש בו בזמן הגשם.
   • הוראה ספציפית יכולה להיות לוודא ששתי הידיים והמכשיר יבשים לפני שתחבר את המכשיר לשקע החשמל.
   • ספק תמונות (כמו גולגולת ועצמות צולבות) או טקסט בצבע שונה (כגון טקסט אדום) כדי להבדיל את האזהרה משאר ההוראות שבממשק המשתמש ולהפנות את תשומת לב המשתמשים אליו.
3. תאר את המכשיר. התיאור שלך צריך לכלול גם הסבר כתוב על מטרת המכשיר וגם ייצוג גרפי קטן של מראה המכשיר. על הדמות לתייג ולתת שם לכל המתגים, הכפתורים והחלקים הניתנים לחיבור הכלולים בהתקן.
4. ספק הוראות התקנה. על סעיף ההתקנה להכיל מידע בסיסי כיצד להתכונן לשימוש במוצר או במכשיר. אם לא ניתן לבנות או להגדיר את המכשיר על ידי משתמש ביתי, ציין זאת בבירור בכותרת מודגשת בחלק העליון של קטע ההתקנה. עליך לכלול גם את הדברים הבאים:
   • רשימת חלקים
   • הוראות לפרוק
   • אזהרות התקנה
   • השלכות של התקנה שגויה
   • למי להתקשר במקרה של קשיים במהלך ההתקנה
5. ספק מידע על הפעולה. סעיף זה הוא החלק החשוב ביותר במדריך למשתמש ועליו לספק מידע קונקרטי ומפורט על אופן השימוש במכשיר. התחל בהכנות בסיסיות לשימוש ביחידה, כגון חיבור כבל החשמל או שטיפת ידיים. המשך בצעדים לוגיים ממוספרים המתארים את אופן השימוש במכשיר, כמו גם כל משוב (לדוגמא "תשמע לחיצה ...") שהמשתמש יכול לצפות לו כאשר הוא משתמש בהתקן כראוי.
   • בסוף פרק זה, יש להפנות משתמשים לפרק פתרון הבעיות בכדי לפתור בעיות שלא ניתן להסביר במהירות.
   • הצב תמונות במידת הצורך. כמה צעדים מוסברים בצורה הטובה ביותר הן בתמונות והן במילים. שקול את השימוש בתמונות או באיורים במדריך שלך.
   • בסעיף זה, כמו בכל סעיף, עליך לכלול אזהרות בטיחות רלוונטיות לגבי שימוש או פעולה לא תקינים. לדוגמא, אתה יכול להזהיר משתמשי מסור שרשרת שלא לשתות אלכוהול או להשתמש במסור המנסרים כאשר הם נמצאים בתרופות מסוימות.
   • אם אתה חושב שמשתמשים ירוויחו, שקול לכלול קישורים לסרטונים מקוונים המדגימים שימוש ותפעול נכון של המכשיר. ניתן להקליט סרטונים אלה בתחילת חלק זה, או (במקרה של סרטונים הממחישים שלב אחד בלבד) בסוף כל שלב.
6. כלול בסוף את סיכום המוצר. הסיכום אמור להופיע בסוף המדריך, ממש לפני האינדקס, כדי לספק שלבי הפעלה בסיסיים. זו צריכה להיות גרסה פשוטה ומופשטת של המידע המבצעי, ולא צריכה להיות יותר מדף אחד. סכם את אופן השימוש במכשיר או במוצר. כלול התראות בסיסיות, שלבים ממוספרים שמסבירים כיצד להשתמש במוצר ומספרי טלפון או כתובות דוא"ל המפנות משתמשים לעזרה.
   • אם אתה מצפה מהמשתמש להסיר או להתייחס לדף הסיכום לעיתים קרובות, אתה יכול להדפיס אותו על גבי כרטיס למינציה נשלף או על קרטון עבה כדי להקל על המשתמש לשאת ולהתייחס אליו.
   • לחלופין, ניתן להחיל סיכום ישירות על המוצר לצורך התייחסות מהירה וקלה על ידי המשתמש.

חלק 3 מתוך 4: תיאור תחזוקת המוצר

1. הסבירו כיצד לנקות את המכשיר. אם המכשיר או המוצר שלך זקוקים לניקוי, הסביר כיצד לעשות זאת. ציין את חומרי הניקיון הנדרשים. ספר לקורא באיזו תדירות לנקות. ואז, כמו בכל חלק אחר במדריך, כלול הוראות שלב אחר שלב ממוספרות כיצד לנקות אותו.
   • אם ניקוי דורש פירוק המוצר, או הסרת חלק או חלקים מסוימים, ציין כיצד יש לפרק את המוצר.
   • ספק אזהרה לגבי תוצאות כשל בניקוי המכשיר. לדוגמה, אתה יכול לומר, "אם המכשיר לא ינוקה, הביצועים יהיו פחות אופטימליים."
2. ספר את המשתמש כיצד לבצע תחזוקה בסיסית. אם המוצר או המכשיר ניתנים לשירות המשתמש על מנת לתקן בעיות ביצועים, ספק הוראות ממוספרות כיצד לעשות זאת למשתמש. לדוגמא, אם יש צורך להחליף את הסוללות לאחר כל 300 שעות שימוש, ספק הוראות כיצד לבדוק אם יש צורך להחליף את הסוללות, כיצד להסיר את הסוללות המתות וכיצד להתקין את הסוללות.
   • אם יש משימות תחזוקה מסוימות שניתן לבצע רק על ידי טכנאי מוסמך, חלק את חלק התחזוקה של המדריך לשני חלקים.
3. דון באפשרויות אחסון. במידת הצורך, במדריך יש להסביר כיצד לאחסן כראוי את המוצר או המכשיר. עליך לכלול גם מידע מדוע אחסון הכרחי וההשלכות של אחסון לא תקין. לדוגמא: אתה יכול לכתוב:
   • אחסן את המוצר במקום קריר ויבש. אחסון לא תקין יכול לקצר את חיי המוצר שלך בגלל הצטברות לחות. "
   • "אל תחשוף את המוצר לחום או לאחסן אותו בטמפרטורות מעל 50 מעלות צלזיוס.אם כן, זה יכול להוביל לבעירה. "
4. ספק מידע על פתרון בעיות. אתה יכול לארגן את החלק הזה כרשימה של בעיות נפוצות ופתרונותיהן. קבץ בעיות דומות תחת כותרת הגיונית. באופן זה, משתמשים יכולים למצוא במהירות בעיות ספציפיות.
   • לדוגמא, אם ישנן מספר בעיות במחשב המציג מסך כחול, קיבץ אותן תחת כותרת משנה, כגון "בעיות מסך נפוצות".
   • עליך גם לכלול מספר טלפון ו / או דוא"ל לשירות לקוחות בסעיף זה.

חלק 4 מתוך 4: כתוב מדריך קריא

1. קרא מדריכי משתמשים אחרים. לפני כתיבת מדריך למוצר משלך, עיין במדריכי משתמש יעילים אחרים. שימו לב למבנה, לבחירת מילים ולמבנה המשפט. מותגים עיקריים כמו אפל, גוגל ומיקרוסופט מייצרים מדריכי משתמש חזקים ויעילים שיכולים לעזור לך לייצר מדריך למשתמש בכתב יותר.
   • לא רק לקרוא את כל מדריכים למשתמש. קרא את המדריכים למוצרים דומים שאתה מוכר. לדוגמא, אם אתם מוכרים מוצרי תינוקות, קראו מדריכים לתינוקות, ולא טכניים.
2. בחר את הסטנדרטים שלך. סטנדרטיזציה של איות, בחירת מילים וניסוח תהפוך את מדריך המשתמש לידידותי יותר למשתמש. מדריך הסגנון של שיקגו ומדריך הסגנון של מיקרוסופט יכולים גם להיות מדריכי סגנון מועילים בעת כתיבת מדריך הבעלים שלך; בדוק את שניהם כדי לראות אם אחד מתאים למדריך שלך.
   • לדוגמא, במקום להשתמש גם ב"מתג הפעלה "וגם ב"כפתור הפעלה" במדריך שלך, בחר באחד משני המונחים ויצמד אליו.
3. השתמש בקול הפעיל. הקול הפעיל הוא דרך כתיבה המסבירה דברים מנקודת מבט המשתמש. קל יותר להבין מאשר האלטרנטיבה, הקול הפסיבי, שבו הנושא אינו מוגדר.
   • נסה את אפליקציית המינגווי (www.hemmingwayapp.com) כדי לזהות קטעים פסיביים בכתיבתך.
   • עיין בשני משפטים לדוגמה אלה - הראשון פעיל והשני פסיבי:
     • עליכם לפתוח את האריזה לאט ובזהירות.
     • יש לפתוח את האריזה לאט ובזהירות.
4. כתוב הוראות ממוספרות. הוראות לפי סדר מספרי עוזרות לקורא להתמקד טוב יותר בתהליך השימוש, החיבור או הבנייה של המוצר הנדון. במקום לכתוב פיסקה ארוכה ורבודה או סדרת פסקאות לא ממוספרות, כתוב את המדריך למשתמש שלך בצעדים פשוטים ומפורשים, שכל אחד מהם ממוספר בבירור.
5. התחל כל צעד בציווי. ציווי הוא פועל מוכוון פעולה. על ידי התחלת כל שלב בפועל, אתה נותן לקורא רמז לגבי הפעולה הנדרשת להשלמת הצעד. לדוגמא, תלוי במוצר שעליו אתה כותב, אתה יכול להתחיל את צעדיך בפקודה כמו "התחבר", "אשר" או "שקף". עם זאת, אל תתחיל את צעדיך בתגובה מהמערכת.
   • לדוגמה, אם המסך הופך לכחול ומתחיל להבהב, אל תתחיל את השלב עם: "המסך יהבהב ויהפוך לכחול." נסה: "לחץ והחזק את מקש הבית. המסך יהבהב ויהפוך לכחול. "
6. קבע באיזה אוצר מילים תשתמש. אם אתה כותב מדריך יו-יו, הקהל שלך יהיה בעיקר ילדים צעירים. השתמש במילים פשוטות ובאוצר מילים כדי להסביר כיצד פועל יו-יו. כשאתה כותב מדריך לסריקת מיקרוסקופ אלקטרונים, הקהל שלך מורכב מדענים מיומנים מאוד שיכולים להבין מידע מפורט מאוד, אז אל תרתע משימוש באוצר מילים מיוחד או בהסברים ניואנסים.
   • באופן כללי, אתה מנסה להימנע מז'רגון ושפה טכנית.
   • כדי להיות יעיל עבור בסיס המשתמשים הרחב ביותר האפשרי, נסה לכתוב ברמה מכיתות ו'-ז 'בבית הספר היסודי.
7. בעת משלוח מוצר לחו"ל, וודא שהתרגומים שלך מדויקים. שכר מתרגם לתרגום מדריך המשתמש שלך לשפת האם של המדינה שאליה אתה שולח את המוצר שלך. אתה יכול גם להשתמש בתוכנית תרגום מקוונת, אך בקש מדובר שפת אם לקרוא את התרגום ולבדוק אם קיימות שגיאות.
   • אם קבוצות שפה מרובות מיוצגות בקהל שלך, כלול תרגומים של מדריך למשתמש בכל שפה רלוונטית.
   • על המתרגם להכיר את המוצר מכיוון שישנן מילים שונות בשפת היעד עבור מונחים ספציפיים שאינם תרגום מילה במילה.
8. כתוב במשפטים קצרים. במקום כמה פסקאות ארוכות, אתה משתמש בהרבה פסקאות קצרות. חפש הפסקות הגיוניות בכל קטע ועכל מידע שימושי בנתחי משפט או שניים. הדבר נכון ברמת המשפט. שמור על משפטים קצרים ופשוטים, ולא ארוכים ומילוליים.
   • אם שלב מתארך מדי, פרק אותו לשלבים קטנים יותר. זה לא יפחית את ספירת המילים, אך מעברי השורות יקלו על הקריאה.
9. בדוק אם אין שגיאות במדריך. מדריך עלול לאבד אמינות עקב שגיאות דקדוק ואיות. בקש מעמית או כותב טכני לערוך ולהגיה גם את המדריך. בנוסף לאיות ולדקדוק, על מגיה לשים לב לדברים הבאים:
   • קול פסיבי
   • שפה לא ברורה או מבלבלת
   • מבנה משפט עטוף
   • פסקאות ארוכות מדי

טיפים

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