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

שלב 1

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

שלב 2

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

שלב 3

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

שלב 4

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

שלב 5

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

שלב 6

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