צוותי תיעוד יכולים להפוך ידע מוצר מאושר למדריכים לרגעים שבהם משתמשים צריכים לפעול. הפרויקט הראשון המועיל ביותר מחבר שאלה חוזרת למקור אמין, למוצר המתאים ולמשימה שאפשר לבדוק בפועל.
מצאו משימה שמסתתרת בספרייההציגו בבירור את האחריות למקורהגדירו אחריות לשימוש חוזר בערוצים שונים
תהליך התמיכהצוותי תיעוד מוצר, כתיבה טכנית וניהול ידע
ידע מקור
מדריכים, נהלי עבודה תקניים, סרטונים ותוכן מרכז העזרה.
תשובות על המוצר
תשובות המבוססות על תיעוד המוצר.
עמודים מונחים
שלבים אינטראקטיביים, בדיקות ותמיכה חזותית.
העברה ברורה
הכינו את הקשר המוצר והבעיה לצוות הבא.
בעיה
מה תהליך העבודה הזה עוזר להכין
צוותי תיעוד יכולים להפוך ידע מוצר מאושר למדריכים לרגעים שבהם משתמשים צריכים לפעול. הפרויקט הראשון המועיל ביותר מחבר שאלה חוזרת למקור אמין, למוצר המתאים ולמשימה שאפשר לבדוק בפועל.
השתמשו בהקשר הבא כדי לאפשר בדיקה של הבקשה או המשימה: שאלה חוזרת, מוצר מתאים, מקור מאושר, מפת מונחים, אחראי בדיקה, תהליך שינויים. תעדו מה אומת ומה עדיין אינו ידוע, ואז השתמשו במקור המוצר המתאים כדי לקבוע את הצעד המאושר הבא.
הנחיות מעשיות
בצעו את המשימה עם ההקשר הנכון.
מצאו משימה שמסתתרת בספרייה
בדקו שאלות תמיכה כדי למצוא בלבול חוזר בנוגע לחלק, לבקר או לשלב אחד. מצאו את התשובה המאושרת וזהו את תחולת המוצרים שלה. התחילו במשימה המוגדרת הזו במקום לבנות מחדש כל מדריך או לבחור תוכן רק משום שמספר הצפיות בו גבוה.
שאלה חוזרת
מוצר מתאים
מקור מאושר
הציגו בבירור את האחריות למקור
תעדו את מהדורת המדריך או המאמר, את מומחה התחום האחראי ואת מצב הבדיקה. מדריך הוא תוכן נגזר שדורש אותה תשומת לב לשינויים כמו המקור שלו. לפני הפרסום, החליטו איך עדכון יגיע לתצוגה החזותית, לטקסט המשימה ולידע של העוזר.
מפת מונחים
אחראי בדיקה
תהליך שינויים
בדקו טיוטות שחולצו מול המקור
בינה מלאכותית יכולה לעזור לארגן טקסט ושלבים מוצעים, אך הכותב ואחראי המוצר מאמתים את ההתאמה. שמרו הפניות מעורפלות לתרשימים, תנאים חסרים ומונחים לא עקביים ברשימת בדיקה. אל תאפשרו לטיוטה שוטפת להסוות פער במקור שעדיין דורש מידע מההנדסה.
דוגמה: התמיכה משתמשת בשם אחר לחלק
מקרה עריכה להמחשה: לקוחות קוראים לאביזר חיבור תושבת, בעוד המדריך משתמש במונח קטלוגי. המדריך מחבר את שני המונחים לתווית המאושרת ולמיקום בתרשים. מזהה החלק הקנוני נשאר ללא שינוי, וההסבר ברור בלי לשנות את זהות חלקי המוצר.
הגדירו אחריות לשימוש חוזר בערוצים שונים
השתמשו באותה משימה מאושרת מדף מוצר, ממאמר תמיכה או מנקודת כניסה באמצעות QR, לפי הצורך. ודאו שכל כניסה קובעת דגם ומהדורה. שימוש חוזר צריך לצמצם הסברים סותרים ולא לשכפל תשובה שלא נבדקה לכמה דפים.
מדדו את השאלות שהמדריך עדיין משאיר פתוחות
תעדו אי־התאמות למקור, הבהרות חוזרות ושאלות ללא מענה לפי משימת מוצר. בדקו את הסימנים האלה עם אחראי התיעוד. תנו עדיפות לתצוגה ברורה יותר או לסעיף מקור חסר לפי הראיות, והשוו משימות מקבילות לפני שתייחסו שינויים בהיקף התמיכה למדריך.
שדות לשימוש חוזר ברשומה הבאה
הכינו רשומה למדריכי מוצר אינטראקטיביים לצוותי תיעוד שמחברת את המקור למשימה בפועל. העתיקו את שדות ההקשר שלהלן לתהליך המוצר, התמיכה או הבדיקה שלכם. הוסיפו הפניה למקור המתאים ואת האחראי, כדי שהצוות הבא יראה מה עדיין דורש אישור.
שאלה חוזרת
מוצר מתאים
מקור מאושר
מפת מונחים
אחראי בדיקה
תהליך שינויים
תהליך עבודה
הכינו תהליך עבודה ראשון שנבדק
01
קבעו את ההקשר
תעדו שאלה חוזרת, מוצר מתאים ומקור מאושר, וזהו את המקור הרלוונטי.
02
בדקו משימה אחת
השתמשו בתרחיש הגדרת האחריות לשימוש חוזר בערוצים שונים כדי לדון בהיקף, ואז בדקו עם האחראי את המשימה בפועל ואת השדות שטרם הושלמו.
03
בדקו את ההעברה הבאה
שמרו ברשומה שהתקבלה את מפת המונחים, אחראי הבדיקה, תהליך השינויים והשאלה שלא נפתרה.
שאלות נפוצות
שאלות על משימה זו.
מהו מדריך ראשון סביר לצוות כתיבה טכנית?
בחרו שאלה חוזרת אחת על מוצר עם מקור מאושר ותוצאה ברורה למשימה. כיוון מבלבל או מזהה חלק לעיתים קרובות קלים יותר לבדיקה מהעברה של מדריך מוצר שלם.
אילו שדות צריכה הרשומה לכלול?
השתמשו בשאלה חוזרת, מוצר מתאים, מקור מאושר, מפת מונחים, אחראי בדיקה ותהליך שינויים. הפרידו בין מזהים מאומתים, תצפיות ושאלות לא פתורות כדי שהאחראי הבא יוכל לבחור את המקור המתאים.
כיצד יש לטפל בפרט מוצר שאינו ידוע?
סמנו פרט חסר כלא ידוע והציגו בבירור את האחראי לאימותו. השתמשו בשאלה החוזרת וברשומות המקור הזמינות כדי לבסס את ההקשר לפני מתן תשובה למוצר מסוים.
כיצד Viflux יכולה לעזור בתהליך הזה?
הביאו מוצר אחד ואת המקור המאושר לשאלה חוזרת. הדגמה ממוקדת יכולה להראות איך תצוגות עם תוויות, שלבים שנבדקו או רשומת תמיכה ברורה יותר עוזרים עם שאלה חוזרת ומוצר מתאים. הסכימו על הכנה ובדיקה לפני הרחבת החוויה.