- המאפיינים העיקריים של ההוראות
- מִבְנֶה
- 1. הקדמה
- 2- נקודות קשר
- 3 - פונקציות עסקיות ראשוניות
- 4 - מילון מונחים
- 5- יכולות מערכת או מוצר
- 6- תיאור הפונקציות
- 7- הכנת פונקציות קלט
- 8- תוצאות
- 9- הוראות הפעלה
- 10- תחזוקה
- 11- שגיאות
- דוגמאות להוראות
- 1- הוראות להרכבת הכיסא
- בִּטָחוֹן
- תכנית בניה
- דיאגרמת
- מחשבון LTA
- הפניות
הדרכה היא מסמך שמטרתו לתת קצת מידע על איך לעשות משהו מסוים. טקסטים אלה משמשים כמדריך עבור האדם לדעת את הדרך הנכונה לבצע פעולה או לקבל מידע על משהו.
ברוב ההוראות יש מדריך או טקסט כתוב עם ההוראות, בתוספת תמונות נלוות (כגון דיאגרמות) שיכולות לעזור לאדם להבין את השאלה.
הרעיון הוא שההוראות נכתבות בצורה לא טכנית כך שניתן יהיה להבין אותם במספר האנשים הגדול ביותר.
רמת המינוח הטכני ורמת התוכן חייבות להיות שונות ממדריך מומחה, מכיוון שההוראות חייבות להיות מכוונות לאזרח המשותף.
מסיבה זו, חשוב להגדיר למי המדריך מופנה; לקוראים שונים יהיו דרישות שונות.
בנוסף, ההוראות צריכות להיות בעלות מבנה הכולל את הכיסוי, הקדמה, מילון המילים, התיאור הכללי וההוראות, בין שאר האלמנטים.
כפי שמשתמע מהשם, ההוראות הן טקסטים שנכתבו כדי לעזור לאנשים להבין כיצד להשתמש במערכת.
ככלל, ההוראות נחוצות בעת הטמעת מערכת תוכנה טכנולוגית, הרכבת רהיטים או הוראות לשימוש במכשיר אלקטרוני.
ההוראות צריכות להיות הפריט הראשון שקרא בעת רכישת מוצר חדש.
על ידי קריאת מדריך ההוראות, ניתן לפתור ספקות רבים בנושא ללא צורך בתמיכה טכנית או תמיכה מהיצרן.
המאפיינים העיקריים של ההוראות
- כלולות הוראות צעד אחר צעד לשימוש במוצר.
- הם מכילים לחלוטין את כל ההוראות למוצר, בכל דרך אפשרית.
- הם מתחילים במדריך למשתמש מהיר של דף אחד.
- הם אומרים למשתמש מהן הפונקציות של המוצר ולמה הן מיועדות, ולא רק כיצד להשתמש בפונקציות הללו.
- הם לוקחים בחשבון את צרכיהם של משתמשים מוגבלים (כגון ראייה נמוכה או עיוורון צבעים) ומספקים הוראות חלופיות למשתמשים אלה, כגון שמע, ברייל או הדפס גדול יותר.
- הם משתמשים בשפה אחת בלבד.
- יש להם שימוש יעיל בצבע.
- דפיו ממוספרים ויש להם אינדקס.
- יש להם תמונות או דיאגרמות המסייעים להבנת המוצר וההוראות.
- הם משתמשים בגופן נקי וקריא; המשמעות היא שהם אינם משתמשים בגופני serif.
מִבְנֶה
1. הקדמה
הוא מכיל את כל המידע החיוני שהמשתמש יוכל להשתמש במערכת או במוצר כולו. חלק זה אמור לכלול תיאור של פונקציות המערכת ויכולותיה, מגבלות ואמצעי פעולה אלטרנטיביים, נהלים צעד אחר צעד ושימוש.
במידת האפשר, השתמש בגרפיקה. פרק זה מספק גם תיאור של מטרת ההדרכה, ארגונו והפניות האפשריות.
2- נקודות קשר
פרק זה מזהה את קודי הארגון והצוות שיכולים לסייע למשתמש. אם יש קו עזרה או דלפק עזרה כלשהו, זה מתואר בסעיף זה.
3 - פונקציות עסקיות ראשוניות
פרק זה כולל את הפרספקטיבה העסקית של תחומי האחריות העיקריים של המשתמש ביחס למוצר או למערכת.
4 - מילון מונחים
להלן מילון המונחים של מונחים וקיצורים המשמשים בהוראות. אם הוא ארוך מאוד, יותר מכמה עמודים, הוא ממוקם כנספח.
5- יכולות מערכת או מוצר
חלק זה מספק סיכום קצר של מערכת המוצר ויכולותיו; יש לתאר את מטרתו.
הרעיון הוא שהמשתמש יבין את הפונקציות והפעולות של המערכת, כולל פונקציות ספציפיות ברמה גבוהה. יש לכלול גרפים או טבלאות במידת הצורך.
6- תיאור הפונקציות
כל פונקציה ספציפית של המערכת מתוארת. ניתן לכלול את הדברים הבאים:
- מטרה ושימוש בפונקציה. יש להוסיף גם קשרים עם פונקציות אחרות.
- אתחול הפונקציה, אם ישים.
- אפשרויות הביצוע הקשורות לפונקציה ותיאורן.
- תיאור התשומות הצפויות ותוצאותיהן.
7- הכנת פונקציות קלט
פרק זה כולל את התשומות הנדרשות כדי שהמערכת או המוצר יתפקדו כראוי.
8- תוצאות
יש לכלול גם את התוצאות הצפויות של כל פונקציה. תוצאות אלה צריכות לכלול גרפיקה, טקסט וטבלאות שיכולות לעזור למשתמש. בנוסף, מוצבות גם דוגמאות.
9- הוראות הפעלה
רשימת התהליכים הקשורים להוראות ההפעלה ניתנת כאן. לדוגמה, הוא אמור להכיל את הנהלים לכניסה למערכת אם רלוונטי.
הליך אתחול זה אמור לתאר כיצד להגדיר את אופן הפעולה הנדרש וכיצד להתחיל את הפרמטרים הנדרשים להפעלה.
10- תחזוקה
פרק זה כולל נהלים לשמירת המערכת או המוצר כהלכה.
11- שגיאות
סעיף זה אמור להקפיד על כל הודעת שגיאה שעלולה להופיע במערכת או כל תקלה אפשרית בציוד.
לדוגמה, עליך לכלול רשימה של כל הודעות השגיאה שעשויות להופיע, למה הן מתכוונות וכיצד לתקן אותן.
דוגמאות להוראות
1- הוראות להרכבת הכיסא
בִּטָחוֹן
לפני השימוש בכלים, קרא, הבין ופעל לפי הוראות הבטיחות עבור כל אחד מהם. אם אינך מבין, צור קשר עם היצרן.
הגן על העיניים באמצעות משקפי בטיחות, אוזניך בבידוד, והריאות שלך עם הנשמה או מסכה.
תכנית בניה
גזרו לוח עץ בגודל 2x4x8, ארבעה לוחות 1x3x1 ושלושה לוחות 5x3x2.
הרכיב את השולחן על פי התרשים וסמן את נקודות החיבור בפינות בעיפרון. ואז להבטיח את החלקים בעזרת מסמר ופטיש.
המלבנים מייצגים את המשתנים שנצפו; משתני הקרן משתקפים כ- x.
המעגלים מייצגים את המשתנים הגלויים והחצים בתמונות מייצגים את היחסים בין המשתנים.
תכונות מיוחדות כוללות:
1- ניתוח פרטני או קבוצתי.
2- ריבוד, הסתברויות לבחירה, משקולות משוכפלות ותיקוני אוכלוסיה סופיים.
3 - אומדן מרבי לסוגי התוצאות.
דיאגרמת
ניתן להשתמש בו לשרטוט תרשים קלט. כדי להיכנס לפונקציה זו, פתחו את תפריט התרשימים בעורך Mplus. ערכת כלים לציור משמשת לייצור התרשים.
מחשבון LTA
מחשבים הסתברויות מותנות, כולל הסתברויות מעבר סמויות לערכים שונים. ניתן להשתמש בו על ידי בחירת מחשבון LTA מתפריט Mplus של עורך Mplus.
הפניות
- מדריך ידני. התאושש מ- statmodel.com
- מדריך טירונים לבניית רהיטים (2017). התאושש מ- sawsonskates.com
- טיפים לכתיבת מדריכים למשתמש. התאושש מ- userfocus.co.uk
- מדריך למשתמש. התאושש מ- wikipedia.org
- מדריך למשתמש. התאושש מ- klariti.com