לא משנה כמה ממציא, מתכנת או רציונליזציה יהיה גאוני, לפעמים היצירות שלו פשוט לא יכולות לשמש למטרה שלהן נועדו. הסיבה לכך היא מדריך ההוראות שנערך באופן שגוי או העדרו המוחלט. אבל אפילו ממציאים גאוניים כותבים לפעמים הוראות כאלה שמלבד מומחים צרים, אף אחד לא יכול לקרוא את העיתונים האלה. אז איך נכון לערוך מסמך כה הכרחי?
זה הכרחי
- - ידע של מאה אחוז על המכשיר או מוצר התוכנה שעבורם נכתב המדריך;
- - ידע בתחום הבלשנות;
- - כישורי כתיבה.
הוראות
שלב 1
מדריך למשתמש או, במילים אחרות, מדריך הפעלה הוא מסמך שנועד לספק סיוע בשימוש במערכת מסוימת למשתמשים בו. כדי להרכיב מדריך למשתמש, עליכם להכיר את המערכת המתוארת במאת האחוזים, אך להסתכל עליה דרך עיניו של סטודנט בור. נניח כי מדריך למשתמש נכתב עבור כלי תוכנה שעדיין אין לו אנלוגים. דמיין שזו הפעם הראשונה שאתה משתמש בתוכנית זו. מאיפה מתחילים? מה הדבר הראשון שצריך לדעת? ארגן את הידע הזה בקטגוריות בעלות חשיבות.
שלב 2
על ידי חלוקת כל המידע הנוגע ליצירה שלך לקבוצות, ערכת תוכנית לכתיבת מדריך למשתמש. התחל לתאר את העבודה בתוכנית שלך מאפס, והשאיר אחרון לפרטים הקשים ביותר, כגון תכנות תכנות מחדש או התמודדות עם שגיאות קריטיות. בשלב זה, אתה אמור להכין את תוכן מדריך המשתמש - אחד החלקים הנדרשים במסמך זה.
שלב 3
אם המדריך שאתה יוצר מיועד לשימוש בחברה גדולה, עליך לשים לב לסטנדרטים הארגוניים שאומצו שם. לדוגמא, בחברות רוסיות רבות מדריכי משתמשים אינם מתקבלים ללא תמיכה להמחשה, במילים אחרות, תמונות המסבירות את הכתוב. בנוסף לתוכן, על המדריך למשתמש להכיל חלקים חובה אחרים: - הערה, כלומר הסבר על היעדים הכלליים של המדריך והמוצר המתואר; - מבוא המתאר את המסמכים הקשורים למדריך למשתמש וכיצד לשימוש במדריך; - סעיפים המסבירים את השימוש במוצר בשלבי השימוש השונים בו, למשל, צעדים ראשונים, תיקון או תחזוקה; - קטע של שאלות נפוצות ותשובות להן; - מילון מונחים או אינדקס נושאים.
שלב 4
בדרך כלל, כותב טכני מעורב ביצירת מדריך למשתמש - אדם שיש לו את כל הידע הדרוש הן בשפה והן במוצר המתואר. ככותב טכני ללא הכשרה, יש לזכור כמה כללים. ראשית, אסור לך לעשות שימוש לרעה במונחים מיוחדים שאינם מובנים למשתמש רגיל. שנית, יש לפרט ולהסביר כל מונח בו נעשה שימוש. שלישית, עליך לכתוב בצורה ברורה ותמציתית ככל האפשר. לבסוף, כותב טכני חייב להיות מסוגל להסתכל על הטקסט שלהם דרך עיניו של משתמש רגיל על מנת לראות את החסרונות של הטקסט שלהם.
שלב 5
טוב לבדוק את הטקסט המוגמר של מדריך המשתמש בפועל על ידי הצעתו לאדם שלא היה לו שום קשר למוצר המתואר. במאמצים משותפים ניתן לבטל את כל החסרונות והמלכודות שבמסמך.
