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

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

פריטים שתצטרך

• Microsoft Word או תוכנית עיבוד תמלילים אחרת

• אוסף של אוסף תמונות או תמונות דיגיטליות

• פשוט דף אינטרנט authoring תוכנה

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

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

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

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

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

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

טיפים

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

אזהרה

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