מחולל מדריכי משתמש בחינם

מהו מדריך משתמש?

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

תשמעו גם שקוראים לו מדריך למשתמש, מדריך הוראות או תיעוד מוצר. השמות משתנים; התפקיד זהה: לעזור לאנשים להשתמש במוצר בלי לשאול אתכם.

מה כולל מדריך משתמש

המחולל עוקב אחר המבנה שרוב המדריכים חולקים:

• מבוא: מהו המוצר, למי הוא מיועד ומה אפשר לעשות איתו.
• תחילת עבודה: דרישות, הגדרה או כניסה ראשונה, והדבר השימושי הראשון לעשות, כצעדים ממוספרים.
• סעיף אחד לכל תכונה: לפי הסדר שבו משתמש חדש פוגש אותם, עם תוויות ממשק מודגשות.
• הגדרות וחשבון: תפקידים, חיוב והעדפות, כשהמוצר כולל אותם.
• פתרון בעיות: בעיות סבירות ומה לעשות לגבי כל אחת.
• שאלות נפוצות ומילון מונחים: תשובות מהירות והסבר על המונחים של המוצר עצמו.

איזה פורמט תיעוד אתם צריכים?

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

דוגמה קצרה למדריך משתמש

עבור אפליקציית מעקב זמן, סעיף תחילת העבודה של מדריך המשתמש שנוצר יכול להיראות כך:

תחילת עבודה

1. פתחו את אימייל ההזמנה מהמנהל שלכם ולחצו על הצטרפות לסביבת עבודה.
2. הגדירו את הסיסמה שלכם והיכנסו.
3. לחצו על התחלת טיימר, לאחר מכן בחרו לקוח ופרויקט.
4. לחצו על עצירה כשאתם מסיימים. הרשומה תופיע בגיליון השעות השבועי שלכם.

במקום שבו התיאור שלכם לא מספק פרט, כמו שם תפריט מדויק או כתובת URL, המחולל כותב מציין מיקום שתמלאו במקום לנחש.

איך לתאר את המוצר שלכם למדריך טוב יותר

מחולל מדריכי המשתמש מתאר רק תכונות שהטקסט שלכם תומך בהן, לכן האיכות נובעת מהתיאור. רשמו את התכונות העיקריות לפי הסדר שבו משתמש חדש פוגש אותן, תנו שמות למסכים ולכפתורים כפי שהם מופיעים בממשק, וציינו תפקידים, הגדרות וחיוב אם המוצר שלכם כולל אותם. הוסיפו את הבעיות שלקוחות נתקלים בהן הכי הרבה כדי שסעיף פתרון הבעיות יהיה שימושי. מלאו גם את שדה קהל היעד: מדריך למנהלים יכול להיות תמציתי, בעוד שאחד למשתמשים חדשים זקוק לכל צעד.

איך לכתוב מדריך משתמש שאנשים משתמשים בו

ארגנו לפי משימה, לא לפי מסך

קוראים מגיעים עם מטרה: "שליחת חשבונית", "הוספת חבר צוות". תנו לסעיפים שמות לפי המטרות האלה, לא לפי מבנה התפריט שלכם.

כתבו עבור הקורא הכי פחות מנוסה שלכם

הגדירו מונחים בפעם הראשונה שאתם משתמשים בהם ואל תדלגו על צעדים שנראים לכם מובנים מאליהם.

הראו את הממשק

צילום מסך של כל צעד מפתח, או סרטון קצר, עונים על "איפה זה?" מהר יותר מכל תיאור.

התייחסו אליו כמסמך חי

כל גרסה יכולה להפוך סעיף ללא נכון. הקצו בעלים ובדקו את הדפים המושפעים בכל פעם שהמוצר משתנה.

טעויות נפוצות במדריכי משתמש

• תיאור כל כפתור במקום להסביר איך לבצע דברים.
• שימוש בשמות פנימיים שלא תואמים את הממשק.
• קובץ PDF ענק שאף אחד לא יכול לחפש בו, במקום דפים שניתן לקשר אליהם.
• השמטת פתרון בעיות, החלק שאנשים מחפשים הכי הרבה כשהם תקועים.

המחולל עובד מהתיאור שלכם, לא מהמוצר עצמו, לכן בדקו כל צעד והחליפו כל מציין מיקום לפני הפרסום.