Shirley Yardeni
Technical Writing
& Translations

Shirley Yardeni
Technical Writing
& Translations

כתיבה טכנית בעברית | English Technical Writing | תרגום טכני לעברית | Technical Translations English

התקנה מודולרית למערכות מורכבות

בחברת עדית היה צורך לשפר את תהליכי ההתקנה

כל מהנדס שעסק בשלב כלשהו בתהליך ההתקנה הכין מסמך התקנה נפרד במבנה ובניסוח אישי. ללא תיאום בין המהנדסים, נוצרו הרבה מאד תהליכי התקנה שבכל אחד מהם היה עדכון שונה, בהתאם למהנדס שביצע אותו.

המשימה: להכין ספריית קבצים הכוללת את כל שלבי ההתקנה; מקבצים אלו ,תהיה אפשרות להרכיב באופן מודולרי מסמך המותאם לדרישות הספציפיות של כל לקוח.

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

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

הפתרון: המתקין מכין מסמך התקנה שאליו הוא מעתיק את הקבצים הרלוונטיים לפי הסדר שבספריה.

הערך המוסף: מופע יחיד לכל קובץ, וכל מהנדס מעדכן את הקובץ הרלוונטי כך שכל התקנה מקבלת את החומר העדכני ביותר.

הערך המוסף – מיקור בודד Single Sourcing

במקרה זה, הצעתי ליישם שיטה הידועה  כ Single Sourcing – מיקור בודד.
בשיטה זו, כותבים, מעדכנים ומתחזקים כל טקסט פעם אחת בלבד, ומרכיבים את המסמך הסופי מטקסטים אלו, כן, ממש כמו פאזל, כאשר סדר ההרכבה מהותי מאד. 

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

שיטה זו תורמת ליעול משמעותי של עבודת הכתיבה, לצמצום היקף העבודה, ולתחזוקה נוחה

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

דוגמאות

תהליך ההתקנה מורכב ממערכת הפעלה, מבנה נתונים, שרת, מוצר, והתאמות יחודיות ללקוח. התהליך זהה לכל הקונפיגורציות אבל כל קונפיגורציה מורכבת מתמהיל  שונה של מערכת הפעלה, מבנה נתונים, שרת וכו'. 

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

ליצירת קשר, לחץ כאן

לצפייה בהמלצה, לחץ כאן