• מערכת קבצים מודולרית למסמכים מורכבים
מאת שירלי ירדני
הכנת תיעוד מודולרי למערכות מורכבות, באמצעות Word, ללא השקעה בתוכנה יעודית. מקור טקסט אחד משמש להכנת מסמך מודולרי עבור התקנה מורכבת למוצר תוכנה או חבילת מסמכים עבור קו מוצרים.
במקרים רבים קטעי טקסט מסוימים מופיעים במספר רב של מסמכים, בין אם אלו מסמכים שונים של אותו המוצר, או מסמכים שונים של מוצרים דומים.
לדוגמה, תהליך התקנה המורכב ממערכת הפעלה, מבנה נתונים, שרת, מוצר, והתאמות יחודיות ללקוח. התהליך כמעט זהה לכל הקונפיגורציות, אבל כל קונפיגורציה מורכבת מתמהיל שונה של מערכת הפעלה, מבנה נתונים, שרת וכו'.
דוגמה נוספת, סדרת מסמכים של קו מוצרים, כאשר המבוא, תאור החברה, המידע ליצירת קשר, ואולי גם ההדרכה לטיפול בתקלות, זהים בכל המסמכים ולכן אין צורך לתחזק את החומר הכתוב הזה עבור כל מוצר בנפרד.
בגדול, הפיתרון נקרא Single Sourcing
כלומר, מקור בודד, דהיינו קובץ בודד אחיד לכל נושא, ללא קשר למספר הפעמים שהטקסט מופיע בחבילת התיעוד. אכן, יש תוכנות כתיבה יקרות יעודיות בהן נושא זה מובנה. Word אינו תומך בתכונה זו
בשיטה הידועה כ Single Sourcing-, כותבים, מעדכנים ומתחזקים כל טקסט פעם אחת בלבד, ומרכיבים את המסמכים הסופיים מהטקסטים האלו, כן, ממש כמו פאזל, כאשר יש חשיבות עליונה לסדר ההרכבה. יש מתודולוגיה ליישום שיטת Single Sourcing ב-Word.
שיטה זו תורמת ליעול משמעותי של עבודת הכתיבה, לצמצום היקף העבודה, ולתחזוקה נוחה
התקנת תוכנה ארוכה ומורכבת
מערכת הפעלה, מבנה נתונים, שרת, מוצר התאמה ללקוח...
תהליך התקנת תוכנה למערכות גדולות הוא בדרך כלל קריטי, מורכב וכן, גם יכול להיות כואב ומתסכל. במהות, לכל לקוח יש סביבת עבודה שונה שהמוצר זקוק לה כדי לפעול. התאמת המוצר (Customizing) ללקוח הינו נושא בפני עצמו, הכוללת את סביבת העבודה המורכבת, לדוגמה, מהמרכיבים הבאים:
• הבחנה בין מערכת חדשה למערכת לשדרוג
• מערכת הפעלה
• מבנה נתונים
• שרת
• התאמות בין השרת ומבנה הנתונים
• המוצר הנדון
• התאמות יחודיות של המוצר ללקוח
לכל קונפיגורציה יש תהליך התקנה יחודי ו/או תמהיל שונה של מרכיבים המותאם לדרישות המיוחדות של כל לקוח
במסמך מקצועי, כל שלב מודגש, כל פעולה מתועדת בסדרת הוראות פרטניות (שיטת "סמוך, הם יודעים מה לעשות" היא מחוץ לתחום כאן) וכל הוראה מתבססת על הפעולה האחרונה שנעשתה ומתיחסת למה שהמתקין רואה על המסך ברגע הנתון. זוהי גם הסיבה לכך שהמסמך כתוב בזמן הווה, כי בעת ההתקנה, המתקין רואה את מה שהתוכנה כבר ביצעה (בעבר, לפני כמה שניות...), והוא רואה את המסך הנדון ע כ ש י ו.
מה קורה כשאיש תוכנה כותב את מסמך ההתקנה?
בהרבה מקרים מסמך ההתקנה נכתב ע"י מישהו מצוות הפרויקט. שכן, מי כמוהו מכיר את מוצר והתהליך לפני ולפנים? עבור הכותב הזה, רבים מהפעולות הן בנליות ומובנות מאליהן ולדעתו אין צורך לפרט את כל המהלכים.
כתוצאה מכך, לא כל השלבים/פעולות/הוראות מתועדים ולא פעם המתקין בשטח, ככל שהוא מנוסה, הולך לאיבוד. מסמך ההתקנה אינו ממלא את תפקידו, לאפשר למתקין הבית של הלקוח לבצע את התהליך בעצמו, ללא תמיכת החברה המיצרת, ללא טלפונים לתמיכה, למתכנת או אפילו למנהל הפרויקט.
בנוסף, שלא כמו כתב טכני, כותב מצוות הפרויקט וודאי שאינו מתיחס למסמך ההתקנה כמכשיר טכני-שיווקי.
מסמך התקנה טוב מתיחס לכל מתקין כאילו זו ההתקנה הראשונה שלו, והמהדרין כותבים כאילו זו הפעם הראשונה שהמתקין ניגש למחשב
ומה קורה כשלחברה יש קונפיגורציות שונות ללקוחות שונים?
כאן הדבר מסתבך. לכל קונפיגורציה יש כותב אחר, והמסמכים שונים מאד זה מזה במראה ובשיטת העבודה, משום שכל מסמך משקף את יכולות הביטוי והעריכה של הכותב. למרות שרבים מהתכנים זהים (מבנה נתונים זהה אך אפליקציה שונה) הרי בכל מסמך הם מנוסחים באופן שונה. יתרה מזאת, מאחר וכל כותב כזה רואה רק את החומר שהוא כתב, ייתכן שאין שיתוף ידע בין המחלקות. מובן שכל מה שקשור בהיבט השיווקי של המסמך, ב- Look & Feel לא בא לידי ביטוי במסמכים השונים, שהם חלון ראווה למשתמש.
הבעיתיות האמיתית מתעוררת בהיבט של תחזוקת המסמך, כאשר מגיעה גירסה חדשה של מרכיבי המוצר או יש שינוי/שיפור בתהליך ההתקנה; או אז יש לבצע את השינוי בכל מסמך בנפרד, עבור כל קונפיגורציה ולקוח בנפרד. וכידוע, בלשון המעטה, אנשי תוכנה מאד לא אוהבים את משימת הכתיבה, בעיקר כשזה באנגלית. ולבצע את אותו השינוי ביותר ממסמך אחד, את זה איש תוכנה באמת אינו רוצה לעשות.
הפתרון המוצע
תיעוד העידכונים ושיפורי התהליכים מבוצעים פעם אחת בלבד והעידכון מיושם אוטומטית בכל המסמכים של כל הקונפיגורציות, כל המסמכים של קו המוצרים וכל הלקוחות באמצעות Word.
שירלי ירדני הינה כתבת טכנית ומתרגמת בשתי השפות וביניהן, עברית ואנגלית.השילוב הייחודי של יכולות - נסיון וידע רבבכתיבה טכנית,שימוש מושכל ב-Word, English ועברית ברמת שפת אם ומימנויות בעיבוד אלמנטיםגרפיים כגון טבלאות ותמונות - הינו ערך מוסף המניב מסמכיםמקצועיים, מובנים (structured) היטבונוחים מאד לתחזוקה.
http://www.syc-twriting.co.il/
