קפיצת מדרגה בכתיבה טכנית – אפליקציית MadCap Flare
כתיבה טכנית - כולם צריכים! אי אפשר בלי! רובנו לא אוהבים לעסוק בזה! אפשר גם אחרת – ביעילות, בזמן ובחיסכון!
דרור דביר, מהנדס בעל ניסיון רב בניהול ובהנדסת מערכת של פרויקטים מולטי-דיסציפלינריים וכתב טכני מנוסה, מזהה קושי כרוני בהכנת תיעוד טכני ברמה נאותה.
קושי זה יוצר:
• אי עמידה בלו"ז,
• הפקת מסמכים ברמה ירודה,
• השקעת מאמץ נוסף בתיקונים,
• איבוד מידע וידע.
ומכאן:
• חוסר שביעות רצון של הלקוחות,
• פגיעה במוניטין של המוצר והארגון,
• פגיעה ברווחיות.
דביר מוסיף כי "הגורמים לקושי כרוני זה נעוצים במגבלות אינהרנטיות של עובדים, שלא הוכשרו לעסוק בכתיבה, או שאינם מצוידים בכלים מותאמים, שיסייעו בידם:
• רבים מתייחסים לתיעוד טכני כמשימה חשובה, אך לא דחופה ודוחים אותה לרגע האחרון,
• נוצר לחץ זמן הגורם לכתיבה נחפזת ולא בהכרח מדויקת וברורה,
• רוב המפתחים לא אוהבים לכתוב מסמכים,
• לאנשים טכניים אין בהכרח הכשרה מקצועית לכתיבה,
• לעתים התיעוד לא נכלל בתמחור הפרויקט, או תוקצב בערך נמוך."
בהתבסס על ניסיונו, מגיע דביר למסקנה כי הפתרון טמון בהטמעת מתודולוגיה הבנויה על אפליקציה ייעודית לכתיבה טכנית וממליץ על השימוש ב-MadCap Flare, אפליקציה מהמתקדמות בעולם לכתיבה טכנית יעילה, שמאפייניה העיקריים הם:
• בסיס נתונים המכיל את כל החומר להכנת התיעוד (טקסטים, שרטוטים, תמונות, דפי סגנונות, מבנה דפים, ועוד),
• גנרטור דו"חות המכיל הגדרות של סוגי מסמכים וקובצי תוכן עניינים הקובעים את תכולת המסמכים,
• פרקי טקסט שמורים כקבצי HTML, ליצירת מסמכים מקוונים ומודפסים.
• תכונת "Single Source" – פרק נכתב פעם אחת ומשולב במסמכים שונים – חיסכון בתהליך הכנת התיעוד. מניעת טעויות בביצוע עדכונים – עדכון פרק בבסיס הנתונים עובר אוטומטית לכל המסמכים בהם הפרק נכלל.
• ייבוא חומרים מאפליקציות אחרות.
לקבלת תוצאה מיטבית, ממליץ דביר על שילוב המתודולוגיה הבאה :
1. מינוי מוביל מכלול תיעוד טכני – כתב טכני מנוסה, האחראי לאיכות התיעוד ולעמידה בלו"ז ובתקציב,
2. הגדרת מכלול תיעוד לפרויקט – סוגי מסמכים, מתווה לכל מסמך,
3. בניית בסיס נתונים וגנרטור דו"חות,
4. איסוף ואחסון חומרים על ידי הכתב הטכני,
5. הגהה ועריכת "Ongoing" של החומר שנאסף, כך שייראה כנכתב ע"י אדם אחד, בשפה נכונה וברמה טכנית נאותה,
6. הפקת מסמכים בלחיצת כפתור!
השימוש המשולב ב-MadCap Flare ובמתודולוגיה המוצעת, מאפשר ניהול יעיל של תיעוד, מניעת טעויות וחיסכון בזמן ובעלויות.
דוגמה לחיסכון:
הנחות:
• פרויקט תיעוד הכולל שלושה ספרים מודפסים וקובץ עזרה מקוונת, 60 עמודים לספר
• עלות שעת עבודה של כתב טכני – 50$
• זמן כתיבת עמוד בשיטה המסורתית – 6 – 4 שעות
בעידן בו מתקיימת התפתחות טכנולוגית מהירה, לא ייתכן שבתחום הכתיבה הטכנית, שהיא חשובה ומהותית להצלחת פרויקטים, עדיין ייעשה שימוש בשיטות מיושנות. הגיעה העת להיחשף ולהכיר אמצעים חדשים ומתקדמים כדי לבצע פרויקטי תיעוד מוצלחים ויעילים.
קצת על הכותב: דרור דביר – מנכ"ל DvirCom, מהנדס אלקטרוניקה ובעל תואר MBA.
בעל ניסיון עשיר ב:
• כתיבת תיעוד טכני באנגלית ובעברית.
• ניהול והנדסת מערכת של פרויקטי פיתוח מערכות אלקטרוניות מתקדמות
