איך מכינים קובץ עזרה?

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

השג כלי לחיוב עזרה. אמנם ניתן ליצור קובץ עזרה ביד, תוך שימוש בקובץ בפורמט טקסט עשיר (.rtf), אך רוב כותבי הקבצים עוזרים להשתמש ביישום תוכנה כדי לכתוב את קובצי העזרה שלהם, כגון RoboHelp, Help and Manual, Doc-To -עזרה, MadCap Flare או HelpLogix. מרבית כלי העזרה לחיוב כוללים עורך טקסט או עבודה עם תוכנית לעיבוד תמלילים כמו Microsoft Word ומספקים ממשק משתמש המאפשר למחבר העזרה לראות כיצד ייראה קובץ העזרה כשהוא כותב אותו תוך כדי כתיבת קוד מחשב מאחורי הקלעים. כדי לגרום לקובץ העזרה לעבוד. חלק מכלי העזרה לחיבור כוללים גם עורכי גרפיקה ליצירת צילומי מסך שייכללו בקובץ העזרה.

• ישנם מספר פורמטים של קובצי עזרה: הנפוץ ביותר הוא HTML Help, המשמש יישומים הפועלים ב- Windows. (פורמט ישן יותר, WinHelp, כבר אינו נתמך.) ל- Apple ו- Unix יש פורמטים משלהם, כמו גם ל- Sun Microsystems, עם JavaHelp שלה. יישומי תוכנה המיועדים להפעלה תחת מספר מערכות הפעלה עשויים להשתמש במערכת עזרה חוצה פלטפורמות הפועלת בדפדפן האינטרנט של המשתמש. כל כלי הכניסה לסיוע שתשתמש בו אמור לתמוך בפורמטי העזרה שבהם אתה מתכוון ליצור קבצי עזרה.

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

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

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

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

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

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

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

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

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

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

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

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