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