המדריך הזה נועד לעזור לארגונים להבין אילו סוגים של בעיות אפשר לפתור באמצעות תיעוד משופר, ואיך לבחור מדדים מתאימים לפרויקטים של תיעוד.
השלב הנוכחי:
התוכנית 'עונת התיעוד' של 2021 הסתיימה ב-14 בדצמבר 2021. ציר הזמן
תיאור הבעיה
לפני שמתחילים לבחור מדד, חשוב להבין היטב את הבעיה שאתם מנסים לפתור. התשובה צריכה להיות ספציפית ככל שניתן.
- "האיחוד של בקשות משיכה למסמכי ההדרכה שלנו נמשך יותר מדי זמן. שותפי התוכן מוותרים ונעלמים".
- "אנחנו רואים יותר מדי בעיות שנפתחות כדי לקבל עזרה בהבנת קודי השגיאה".
- "צינור עיבוד הנתונים של CI/CD שלנו לא יציב. יותר מדי בדיקות נכשלות מסיבות לא מובנות."
- "האנשים נראים עצבניים בפגישות השבועיות שלנו".
פיתוח השערה
מחפשים סיבה ותוצאה. מה יכול להיות הגורם לבעיה שציינת? חשוב לזכור שלבעיות יכולות להיות כמה סיבות או סיבות חופפות.
- "התהליך של מיזוג בקשות משיכה לתיעוד של תהליך ההצטרפות ארוך מאוד כי אין לנו הנחיות ברורות לגבי סגנון. בודקים שולחים את בקשת העריכה לבדיקה כי הם לא יודעים מה לעשות, או שהם מדברים שוב ושוב עם הכותבים לגבי הפורמט".
- "משתמשים צריכים לפתוח בקשות תמיכה כי הם לא מוצאים מידע על קודי שגיאה במסמכים".
- "הבדיקות של CI/CD נכשלות כי אנחנו נתקלים במגבלות זמן קצוב ובמגבלות תוכנית מהספק שלנו".
- "האנשים בפגישות השבועיות שלנו ממורמרים כי הפגישות מתקיימות בשעה 5:30 בבוקר לפי שעון האזור שלהם".
הצעת פתרון
האם הבעיה הזו ניתנת לפתרון באמצעות מסמכי עזרה חדשים או טובים יותר?
- "אם הייתה לנו מדריך סגנון, המשתתפים ב-commits היו יכולים לבדוק אותו לפני שליחת בקשות העריכה שלהם. הבודקים ידעו מה לבדוק. הבודקים והכותבים לא יצטרכו להתווכח על הפורמט, הטון והסגנון של המאמרים".
- "אם הייתה לנו תיעוד של קודי שגיאה, המשתמשים היו יכולים למצוא את התשובות שלהם שם, במקום לפתוח בעיות".
- "האם נראה לך שתיעוד טוב יותר יפתור את הבעיה שלנו ב-CI/CD?"
- "אפשר להתחיל כל פגישה עם בדיחה של 'דפיקה בדלת'! יצירת אוסף של בדיחות 'דפיקה בדלת' תעזור לנו להתחיל את הפגישות עם חיוך".
התמקדות בנושא
יש לך אפשרות למדוד את הבעיה?
- "מה המשמעות של 'התהליך של מיזוג בקשות תמיכה נמשך יותר מדי זמן'? חודשיים? שבועיים? כמה זמן תורידו את התורמים להמתנה לבדיקה לפני שהם יפסיקו לנסות?"
- "כמה בעיות שקשורות לקודי שגיאה נחשבות ל'יותר מדי בעיות'?"
- "המממ… מה המשמעות של 'ממורמר מדי'?"
בדיקת יכולת המדידה
איך בודקים את המדד המוצע? האם אפשר למדוד אותו בקלות ובאופן מדויק? האם המדידה תלויה בגורם שמבצע אותה?
- "אנחנו יכולים למדוד בקלות כמה זמן בקשת משיכה הייתה פתוחה, וכמה זמן חלף מאז שנשלחה בקשה לבדיקה. אנחנו לא יכולים למדוד בדיוק מתי תורם מפסיק לתרום".
- "אנחנו יכולים לספור כמה בעיות מתויגות בתג 'error-code' או לחפש בתוך הבעיות טקסט של קוד שגיאה".
- "אנחנו לא יכולים למדוד את רמת העצבים של אנשים בצורה רגישה או מדויקת".
הוספת מדד משני
האם יש מדדים אחרים שיעזרו לך להבין אם התיעוד עוזר לך לפתור את הבעיה? האם מדד היעד זהה בכל מקרה?
- "בדיקת בקשות תמיכה ארוכות יותר אורכת יותר זמן, ולכן צריך להגדיר ערכי סף שונים לבקשות תמיכה בגדלים שונים. אנחנו רוצים למדוד את משך הזמן שחלף עד למיזוג של בקשות תיקון קטנות, בינוניות, גדולות וגדולות במיוחד".
- "אנחנו יכולים לבדוק כמה ביקורים מתקבלים במסמכים שלנו בנושא קודי שגיאה, ולראות אם המספר הזה קשור למספר קטן יותר של בעיות שנפתחות".
בחירת תקופת זמן
- "אנחנו חושבים ששבועיים הם זמן סביר למיזוג בקשות תמיכה קטנות עד בינוניות, וכל בקשות התמיכה צריכות להתמזג תוך חודש. לכן נמדוד כל שבועיים".
- "אין טעם לעדכן מדי יום את מספר הבעיות שקשורות לקוד השגיאה, כי הזמן הממוצע לסגירת בעיה הוא שבוע. נמדוד את זה מדי שבוע".
הגדרת יעדים
איזה שינוי צריך להיות במדד שבחרתם כדי שתוכלו לומר שהפרויקט היה מוצלח? כדאי להגדיר יעדים כמותיים למדדים שבחרתם.
- "אם נגיע ליעד שלנו לסגירת כל פנייה חדשה ליחסי ציבור תוך פחות מחודש, נחשב את זה להצלחה. אם זמן הסגירה הממוצע של בקשות תמיכה גדולות יתקצק בשבועיים, זה יהיה הצלחה עצומה".
- "במצב אידיאלי, לא נראה בעיות חדשות שקשורות לשגיאות. אבל נחשב את הפרויקט למוצלח אם נראה ירידה של 50% במספר הבעיות שנפתחות שקשורות לשגיאות".
מידע קשור
- במדריך לאדמינים ארגוניים תוכלו למצוא עזרה במשימות שקשורות לדוחות.