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