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