לעתים קרובות מילאו ז'רגון, ראשי תיבות וכיוונים הדורשים דוקטורט להבין, מדריכים למשתמש בתוכנה נכתבים לעתים מנקודת המבט של מפתח ולא של משתמש. כתוצאה מכך, המדריך עשוי להניח הנחות לגבי רמת המיומנות של הקורא, שלעתים קרובות אינן נכונות. השלב הראשון בכתיבת מדריך למשתמש טוב הוא לקבל את תהליך הכתיבה בפועל רחוק מהמהנדסים ככל האפשר.
מפתח התוכנה יודע יותר מכל אחד אחר מה עושה את העבודה התוכנה, אבל זה לא אומר היזם צריך לכתוב את המדריך. להיפך, זהו חסרון מובהק. חשוב יותר הבנה עמוקה של פעולתו הפנימית של התוכנה היא הבנה של מי יהיה משתמש הקצה יהיה, מה רמת החינוך שלו, וכיצד משתמש הקצה יהיה באמצעות התוכנה. ברוב המקרים, משתמשי הקצה לא צריכים לדעת את נקודות עדינות של תכנות ואת back-end workings של התוכנה - הם רק צריכים לדעת איך להשתמש בו כדי להפוך את עבודתם קלה יותר.
בדיקות משתמש
המדריך למשתמש צריך להיות בעיקר משימה מונחה, ולא תיאורי בכבדות. בגלל המדריך נכתב כדי לעזור למשתמשים להבין כיצד לבצע משימות ספציפיות, הכותב צריך להיות הבנה של משימות אלה גם כן, וכתוצאה מכך, עובר כל צעד בדידה של כל תכונה היא חיונית לחלוטין. זה לא הכרחי עבור הכותב בהכרח יודע איך התוכנית נוצרה מתוך עיצוב או נקודת מבט, אבל זה חיוני כדי להיות בעל ידע חזק של כל התכונות שלו. בעת ביצוע כל משימה, הקדש זמן לכתוב כל צעד, כולל קליקים, תפריטים נפתחים ופעולות אחרות.
תהליך הראיון
למרות היזם לא צריך להיות אחד לכתוב את המדריך, היא עדיין תהיה משאב יקר עבור הסופר, ולפני תחילת הכתיבה, לתכנן מפגש בעיטת הפתיחה בין סופר, מפתח ומהנדסים, משתמשי קצה פוטנציאליים כדי לעזור להודיע עבודה של סופר מההתחלה. יש לרשום ראיונות עם מומחים לנושא ולמהנדסים, עם תמלילים שנעשו לעיון מאוחר יותר.
תמונות
מדריך למשתמש לא צריך להיות כבד מדי. במקום זאת, לשלב את השימוש הליברלי של גרפיקה קליפים מסך. תיאור הפעולה הוא הרבה יותר ברור עם כיוונים מבוססי טקסט מלווה קליפ מסך זה ממחיש בבירור כי הכיוון. כלול הן לפני צפיות והן לאחר מכן, כדי להציג את מראה המסך לפני ביצוע כל פעולה, ומה קורה לאחר ביצוע הפעולה. כלי פשוט לכידת מסך כגון כלי Snipping הכלול ב- Microsoft Windows עובד היטב עבור לכידת תמונות אלה. הקפד למספר כל תמונה, וכולל כיתוב המתאר אותו בקצרה. מרכז אותו מיד מתחת לפסקה כי הראשון מציג את המושג המתואר בתמונה.
עיצוב
תקשורת בבירור במסמך טכני דורשת תכנון והקפדה על סטנדרטים לאורך המדריך. תקנים הן בהצגה, בשפה והן במינוח מסייעים במניעת בלבול. תבניות זמינות והוא יכול להיות נקודת התחלה טובה אחידות, אם כי אלה בהחלט יכול להיות מותאם כדי להתאים לכל מצב. באמצעות שולי אינץ 'אחד עם עמודה אחת הטובה ביותר מתאים את הצורך להוסיף גרפיקה; הגדרה של שתי עמודות עשויה להופיע צפופה מדי, ויכולה לגרום למיקום של תמונות מבלבלות.
גרסאות ומעקב
יותר מכל סוג אחר של מסמך, מדריך למשתמש התוכנה צפוי לעבור איטרציות מרובות לפני שהוא הושלם, וזה צפוי לעבור תהליך סקירה על ידי בעלי עניין מרובים. השימוש בתכונה 'מעקב אחר שינויים' ב- Microsoft Word הוא דרך קלה לעקוב אחר ההערות והשינויים של כל אדם. יצירת גרסאות מרובות לאחר כל מחזור סקירה, כל אחת עם שם קובץ שונה, גם מסייעת בתהליך יחד ולוודא שכל בעלי העניין מרוצים מהתוצאה הסופית.
