מטרת מדריך זה היא להנחות את בודקי התיעוד כיצד לבדוק תוצרי תיעוד וכיצד להגיש את ממצאי הבדיקה. "תיעוד" כאן הוא כל "מסמך": טקסט, תרשימים, מצגות וכו', בכל פורמט שהוא: מודפס, אלקטרוני וכו', אשר מתאר רכיב זה או אחר של המערכת או ניהולה. עם זאת, הדגש הטבעי הוא על "מסמכי מערכת" מרכזיים, כגון: מסמך ייזום, אפיון, מפרט, תיק מערכת וכו'. ההנחיות שלהלן נכונות לכל מי שמבצע בדיקת תיעוד מכל סיבה שהיא: פונקצית אבטחת איכות בארגון, פונקצית אבטחת איכות בפרויקט, מבקר חיצוני, מבקר פנימי וכו' וגם לכותב את המסמך עצמו (אנשי הפרויקט) לצורך בדיקה עצמית.
חלק מרכזי בעבודת אבטחת איכות הוא בדיקת תוצרים, בכללם תוצרי תיעוד ומסמכים שהופקו לאורך מחזור החיים: מסמך ייזום, תיק אפיון, מפרט, מפ"ל (מסמך פנימי לבדיקת בקשה להצעות), תיק עיצוב וכו'. בבדיקת תוצרי תיעוד אלה יש לפעול לפי ההנחיות המפורטות במדריך זה. הנחיות אלה נכונות לכל מי שמבצע בדיקת תיעוד מכל סיבה שהיא: פונקצית אבטחת איכות מרכזית בארגון, פונקצית אבטחת איכות בפרויקט (נאמן א"א), מבקר חיצוני, מבקר פנימי וכו'. הנחיות אלה טובות גם למי שכותב את המסמך (אנשי הפרויקט) לצורך בדיקה עצמית.
ברוב המקרים, הבדיקה היא צורנית/מבנית ואיננה נכנסת ישירות לתכנים עצמם. התכנים נבדקים בעקיפין דרך הצורה והמבנה,כלומר דרך ההתאמה למפת"ח, מבניות וסדר כלליים ועקיבות פנימית. במקרים נדירים יותר, תגלוש הבדיקה גם לבדיקת תכנים ממש ולחוות דעת באשר למהות המערכת. הבודק יקפיד לציין, אם הבדיקה היא רק צורנית או גם לתכנים, במנהלה של מסמך הממצאים המתואר בסעיף אופן הגשת הממצאים להלן.
בדיקת תיעוד, כמו כל פעילות אבטחת איכות אחרת, יכולה להיעשות במספר אופנים או רמות. שני האופנים העיקריים הם:
הבדיקה מושפעת גם מסוג המסמך כמוסבר להלן, מהחשיבות היחסית של מדדי האיכות וכמובן מסוג הפרויקט ומצבו.
תיעוד טוב נבחן, ראשית ועיקר, במידת עמידתו במדדי האיכות הכלליים הבאים:
בהירות |
יכולת הבנת הנקרא גם ע"י מי שאיננו מצוי בכל פרטי הפרויקט. |
מבניות |
בהתאם לפורמט / תקן של מבנה התוצר הנדון. |
שלמות |
קיום כל הרכיבים / סעיפים הנדרשים. |
התמצאות |
יכולת לעבור בקלות מסעיף לסעיף במסמך ומהמסמך למסמכים חיצוניים בלי לאבד את "נקודת הבסיס" (היכן אני נמצא). |
נכונות |
תכני כל רכיב מתאימים לכותרתו ול"כוונת המחוקק". |
עקביות |
רכיבי המסמך משלימים זה את זה ואינם סותרים. |
רמת פירוט |
בהתאמה לשלב בו נמצאת המערכת וסוג / אופי / היקף הפרויקט. |
תאימות |
התאמה לנהלים ותקנים פנימיים בארגון. |
את תוצרי התיעוד של מערכת ממוחשבת ניתן לסווג עפ"י מספר שיטות:
להסבר מקיף על סוגי התיעוד השונים, ראה קיט תיעוד בכרך נושאים תומכים.
כמעט בכל מקרה מומלץ לבצע תחילה מעבר ראשוני ומהיר על המסמך. מעבר כזה חשוב, ראשית, לבודק עצמו, על מנת לקבל מבט ותמונה כלליים לפני הירידה לפרטים. בסיום המעבר המהיר תתקבל החלטה אם להמשיך בבדיקה מעמיקה או לא. החלטה שלא להמשיך לבדיקה המעמיקה עשויה להיות עקב סיבות שונות:
קשה לקבוע משך זמן לבדיקה מהירה שכן היא מותנית בסוג המסמך ובהיקפו ובפרמטרים רבים אחרים. כלל אצבע: שעתיים עד שלוש.
בבדיקה מהירה וראשונית זו, מומלץ להיעזר ברשימת התיוג הבאה:
בסיום הבדיקה הראשונית יש להחליט אם להמשיך בבדיקה המפורטת או לעצור ולהחזיר את המסמך למגיש. אם הבודק סבור שניתן להמשיך בבדיקה, כל הממצאים שנאספו עד כאן "יירשמו בצד" ויובנו לתוך מסמך הממצאים הסופי המתואר להלן. אם הבודק בדעה שאי אפשר להמשיך בבדיקה הוא ידווח על כך לגורם המתאים בפורמט חופשי, בכתב או בע"פ, לפי נהלי הארגון והפרויקט. הסעיפים לעיל יכולים לשמש מבנה לדו"ח כזה.
המסמך צריך להכיל עמוד שער המציין בברור את:
כל עמוד במסמך צריך להכיל:
ראה קיט כתיבת תיעוד בכרך נושאים תומכים.
בדיקה לקריאות ובהירות כלליים:
א. בדיקה לחמשת הסעיפים הראשיים:
1. יעדים
2. יישום
3. טכנולוגיה
4. מימוש
5. עלות (משאבים)
ב. האם אחד או חלק מהם חסר או "דליל" באופן בולט?
ג. האם יש הקפדה גם בתת הסעיפים (רמה שנייה לפחות) על סרגל מפת"ח?
ד. אם יש נספחים - תמיד בסוף! הנספחים יהיו מסופררים לפי סעיפי עץ המערכת ולא א', ב', ג' וכדומה.
מסעיף 5.5 ריכוז עלויות ופריסתן צריך שיהיה ברור באיזה היקף פרויקט מדובר: ג1, ג2, ג3. סעיף זה צריך גם להיות תואם את ההתרשמות משאר הסעיפים בעיקר מסעיפים 2.21 (נפחים ועומסים), 4.2 (תכנית עבודה) ו- 3.3 (מספר תחנות קצה)
מעמוד השער ומפרק היעדים (ומכל שאר הפרקים), צריך שיהיה ברור באיזה סוג מערכת/פרויקט מדובר:
האם ברור היכן בדיוק נמצאת המערכת/פרויקט על פני ציר מחזור החיים? סוג המסמך ושמו צריך להעיד על כך, אך לא תמיד זה ברור. מקור נוסף הוא פרק המימוש, בפרט סעיפים 4.2 ו- 4.3 מהם חייב להיות ברור היכן נמצאת המערכת.
במערכות מסוג ג1 מותר להגיש מסמך ייזום/אפיון מאוחד. יש לראותו כמסמך אפיון לכל דבר. הבדיקה העניינית תהיה בהתאם ובשלב השני, בבדיקה המעמיקה.
גודל המסמך צריך שיהיה סביר ומתאים לתוכנו ולהיקף הפרויקט:
א. מסמך ייזום: מומלץ 4-7 עמודים, מקסימום 10!
ב. מסמך אפיון/מפרט/עיצוב:
ג. מסמכים עבים במיוחד:
בהמשך לבדיקת סיעוף ומבנה לעיל.
בהמשך לבדיקת סיעוף ומבנה לעיל יש לבצע דגימה אקראית של הסיעוף המשני, האם קיים, האם לא "דליל" או עבה מדי. סעיפים רגישים במיוחד הם:
במקרה של מסמך שהוא המשך של מסמך קודם, כגון אפיון אחרי ייזום, מפרט אחרי אפיון, עיצוב אחרי אפיון וכו', חשוב לבדוק, כבר בבדיקה הראשונית, מה התרומה של מסמך זה ובאיזו מידה הוא ממשיך את המסמך הקודם. גם בלי שהמסמך הקודם לפניך, אפשר לבדוק באופן הבא:
יש לשים לב שהשוואה של התכנים היא נושא רגיש! האם זה בתחום אחריות הבודק? האם זה מה שהתבקש לעשות? בכל מקרה, לא בבדיקה הראשונית.
בדיקות פרטניות למסמכים, תכניות עבודה ותכולת המערכת, יכולות להיעשות באחת משתי הדרכים הבאות:
סעיף זה עדיין ערוך כרשימת תיוג "חופשית", לאורך רכיבי עץ המערכת, ואיננו מותנה בסוג מסמך זה או אחר. ההחלטה אם לפעול לפי סעיף זה או לעבור הישר לסעיף הבא, היא בידי הבודק, בהתאם לנוהלי אבטחת איכות בארגון.
במחזור החיים של מערכת ישנם שלבים בהם מבוצעת בדיקת תיעוד כחלק מתוצרי השלב. יש לפנות לקיטים המתאימים המתארים בפירוט את תהליך בדיקת התיעוד. יש להימנע מכפילות וחזרות.
להלן המלצות לבדיקת "סעיפי המסגרת" של תיקי מערכת. המלצות לבדיקת הרכיבים עצמם, נמצאות בקיטים השונים כמפורט לעיל. כמו כן, גלופת תיק בדיקות תורתי בקיט בדיקות מערכת וגלופת תיק אפיון בכרך יסודות\מחזור חיים הן מאגר הידע המרכזי לפרמטרים לבדיקת תיעוד המפורטת והיסודית. ראה שם.
ראה קיט כתיבת תיעוד בכרך נושאים תומכים, בייחוד הפרק הדן בתמצית מנהלים.
סעיף המנהלה מעניין בפרט אם השלב הנוכחי עדיין לא הסתיים. במקרה זה ייבדקו:
אם השלב הסתיים והמנהלה היא בבחינת "היסטוריה" של ניהול השלב שהביא לכתיבת המסמך, חשיבות בדיקתה יורדת. אך עדיין חיוני לבדוק:
סעיפי הבהקים צריכים לתת מבט כולל ואת "הארכיטקטורה" של הפרק הנדון. עליהם להיות קצרים ותמציתיים. אם יותר מעמוד אחד, יש לבדוק מדוע. לעתים הדבר נובע מתמצית המנהלים הנגזרת מסעיפים אלה. אם לא כך, או אם יותר משני עמודים, יש להעיר על כך ול"פזר" את תוכנו של הסעיף בסעיפים הקונקרטיים המתאימים.
נספחים יסומנו במספר הסעיף אליו הם מתייחסים. למשל:
להוציא מקרים באמת מיוחדים, אין סיבה לשיטה של נספח א', נספח ב' וכו'. בשיטת מפת"ח כל נספח הוא הרחבה של סעיף בגוף המסמך (רכיב בעץ המערכת).
נספחים שכיחים (שחוסר קיומם דורש בדיקה):
בדיקות פרטניות למסמכים, תכניות עבודה ותכולת המערכת, יכולות להיעשות באחת משתי הדרכים הבאות:
יש לשים לב שהמיוחד בבדיקות שנעשות בהתאם לסעיף זה הן הגלופות העומדות לרשות הבודק אשר בנויות כטופס ורשימת תיוג לבדיקה. גלופות אלה מסייעות מאד לבודק, אך גם מחייבות אותו לפעול באופן שיטתי ומאפשרות לבדוק את הבודק. גלופות אלה, לאחר שימולאו בהערות הבודק וממצאיו, יוצמדו לטופס סיכום ממצאי אבטחת איכות לפרויקט הנדון.
שים לב לחלקים המוקדשים למערכות מידע ומערכות תשתית במפת"ח בהם מופיעים עצי מערכת אנכיים (ספציפיים) ובהם מודגשים נושאים ייחודיים למערכות מידע ומערכות תשתית. המידע המופיע שם יכול לסייע בבדיקת מערכות ספציפיות.
מסמך הייזום הוא אומנות של הליכה בשביל הזהב בין כתיבה כללית וקלה לבין מבניות ופירוט המתאימים כבר לאפיון. בדרך כלל לא תהיה "ירידה" לרמה שלישית של עץ המערכת. כלל אצבע: מסמך הייזום לא יעלה על 7 עמודים.
בגלופת הייזום מסומנים רכיבי חובה בכוכבית. למעשה, הדבר תלוי במערכת הספציפית. יש לעבור על כל רכיב בעץ המערכת, לבדוק אם הוא חיוני למערכת הנבדקת, ואם הוא לא קיים יש להתריע על כך.
להנחיות נוספות, ראה גלופת לימוד של מסמך ייזום בקיט יזום כרך יסודות\מחזור חיים.
תיק האפיון מכיל התייחסות לרוב רכיבי עץ המערכת. עם זאת, ברור שמידת הרלוונטיות של כל רכיב תלויה במערכת הספציפית.
אחת הבעיות שאין לה פתרון "מתמטי" הוא הנושא של אפיון יתר או חסר. יש לעבור על כל רכיב בעץ המערכת, לבדוק את מידת חיוניותו למערכת ואם הוא איננו גולש לעיצוב.
מטרת המסמך היא לאפיין את המערכת החדשה, לא לנתח או לתאר את המערכת הקיימת. התייחסות למצב הקיים מופיעה ברכיב 1.3.0 . אם ההתייחסות למצב הקיים היא מעבר לעמוד אחד, יש לוודא קיום נספח 2.1 מצב קיים.
בדיקת הקשר מול מסמך היזום
האם יש שינויים מול הייזום ברכיבים מרכזיים:
1.2 יעדים ומטרות
4.2 לו"ז
5.1 עלות הקמה
בדיקת השגת היעדים
להנחיות נוספות, ראה גלופת לימוד לתיק תיק אפיון בקיט אפיון כרך יסודות\מחזור חיים
להנחיות נוספות, ראה גלופות לימוד של בקשה להצעות ומפ"ל בקיט בקשה להצעות כרך יסודות\מחזור חיים.
האם חלו שינויים ותוספות מהאפיון? (דלתא)
האם שינויים אלו תועדו בתיק העדכני
האם קיימים מסכים? אב טיפוס?
האם קיימים דו"חות?
האם מתגבש מדריך למשתמש?
להנחיות נוספות, ראה גלופת לימוד לתיק עיצוב בקיט עיצוב כרך יסודות\מחזור חיים.
להנחיות נוספות, ראה גלופות לימוד לתיק בדיקות בקיט בדיקות מערכת כרך יסודות\מחזור חיים.
תמצית מנהלים
האם פירוט התקלות ברור?
האם תקלות המשתמשים מתועדות בתיק
האם קיים מידע מספק על מנת לקבל החלטה על המשך?
להנחיות נוספות, ראה גלופות לימוד לתיק סיכום בדיקות בקיט בדיקות מערכת כרך יסודות\מחזור חיים.
להנחיות נוספות, ראה גלופת לימוד לתיק תחזוקה בקיט תפעול ותחזוקה כרך יסודות\מחזור חיים.
מומלץ שהגשת הממצאים של אבטחת איכות תיעשה באופן הבא:
א. במהלך השוטף של הבדיקה ירשמו הממצאים בתוך המסמך המודפס עצמו או כהערות בעותק המגנטי שלו.
ב. עיקרי הממצאים ירוכזו במסמך נפרד - ריכוז ממצאים - כמוצג בטופס לימוד ועבודה בקיט זה.
ג. אם מסמך ריכוז הממצאים משתרע על יותר משני עמודים, תוגש לדרג הניהולי תמצית הממצאים אשר תשתרע על עמוד אחד! הפורמט חופשי, לפי הבנת הבודק או עפ"י נהלי הארגון.
א' ו-ב' יועברו לגורם שהזמין את הבדיקה במטרה ברורה שהוא יעביר את זה הלאה לפרויקט עצמו (אם זה לא אותו גורם). לפיכך הם יכתבו בשפה מקצועית. א' במפורט ו-ב' בצורה יותר כללית. ג' מיועד מראש לדרג הניהולי (וועדת רכש למשל).
חשוב לציין בממצאים גם הערות חיוביות (במידה שיש) וכן להפנות למסמכים אחרים לדוגמא בארגון (אם ישנם).
בקיט בדיקת תיעוד מצויים טפסי הלימוד והעבודה הבאים: