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