כיצד להכין קובץ עזרה: 10 שלבים (עם תמונות)

תוכן עניינים:

כיצד להכין קובץ עזרה: 10 שלבים (עם תמונות)
כיצד להכין קובץ עזרה: 10 שלבים (עם תמונות)

וִידֵאוֹ: כיצד להכין קובץ עזרה: 10 שלבים (עם תמונות)

וִידֵאוֹ: כיצד להכין קובץ עזרה: 10 שלבים (עם תמונות)
וִידֵאוֹ: איך לסרוק מסמך לטלפון שלכם (2020) 2024, מרץ
Anonim

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

צעדים

צור קובץ עזרה שלב 1
צור קובץ עזרה שלב 1

שלב 1. קבל עותק של התוכנה שאתה מתעד

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

צור קובץ עזרה שלב 2
צור קובץ עזרה שלב 2

שלב 2. השג כלי לעריכת עזרה

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

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

צור קובץ עזרה שלב 3
צור קובץ עזרה שלב 3

שלב 3. צור את קובץ פרוייקט העזרה

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

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

שלב 4. התאם את גודל חלון העזרה

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

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

צור קובץ עזרה שלב 5
צור קובץ עזרה שלב 5

שלב 5. כתוב את נושאי העזרה

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

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

שלב 6. כלול צילומי מסך, במידת הצורך

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

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

שלב 7. צור קובץ מפה, אם יש צורך בקובץ מפה

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

צור קובץ עזרה שלב 8
צור קובץ עזרה שלב 8

שלב 8. הידור קובץ העזרה

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

צור קובץ עזרה שלב 9
צור קובץ עזרה שלב 9

שלב 9. בדוק את קובץ העזרה

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

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

צור קובץ עזרה שלב 10
צור קובץ עזרה שלב 10

שלב 10. תן את קובץ העזרה למפתח שיכלול בתוכנית

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

מוּמלָץ: