בטוב שבעולמות האפשריים התיעוד הטכני הינו חלק מהמוצר אותו הוא מלווה. בזמן שהמהנדסים והכתבים הטכניים מפיקים ביחד את התיעוד, רוח המשתמש העתידי מרחפת מעל ראשיהם. ברוב חלקי העולם האמיתי, לעומת זאת, המסמכים הטכניים נוצרים בצורה אחרת משאר רכיבי המוצר. מהנדסים מפתחים את מוצרי החברה, אשר הצלחתם בשוק אמורה להעשיר את החברה. הצלחת המוצרים נמדדת בקבלתם מחוץ לחברה. לעומת זאת, מסמכים טכניים מופקים לטובת מחלקות פנימיות, בתוך החברה, כגון שרות, הנדסה, תמיכה, הדרכה וכו'. לרוב, הצלחת צוות הכתבים הטכניים תלויה ביכולתו לרצות את המהנדסים.
קשר "לקוח-שרת" מסוג זה הופך את צוות התיעוד ל-outsider בחברה ונוטה למקם את הכתיבה הטכנית בפרינג' של המוצר. היו מפתחים שתהו האם התיעוד הטכני אומנם חלק מהמוצר או שמא איזשהו רע הכרחי ויקר.
עבור רוב החברות העוסקות בפיתוח חומרה או תוכנה, התיעוד הטכני מהווה הוצאה אשר רק לעיתים רחוקות יוצרת החזר מדיד על ההשקעה. מסמכים טכניים טובים עשויים להפחית בקריאות לתמיכה טכנית. קורס הדרכה יימכר פה ושם ללקוח פלוני. אבל מעט חברות רואות במחלקת התיעוד מפעל רווחי, דבר שאינו מקל על חיי הכתבים הטכניים או של מנהלי כתיבה טכנית.
מלקוד הזמן
מטבע הדברים, הכתיבה הטכנית תמיד בפיגור. מציאות זו, אשר היא אינהרנטית באופי מעגל פיתוח המוצר, היא תולדה של שתי אקסיומות סותרות זו את זו:
(1) לא ניתן לתעד את אשר לא קיים.
(2) לאחר שהמוצר מתהווה, לא ניתן לתעד אותו באפס זמן.
כתוצאה מזה, לא משנה כמה מהר הכתבים הטכניים כותבים את המסמכים, תמיד נוצר הרושם שהתיעוד מעקב את השקת המוצר. כמובן, הרבה דברים יכולים לעקב את פיתוח המוצר. שבב לא הגיע בזמן. באגים איתנים פוקדים את התוכנה. ללא הרכיבים האלה, המוצר אינו מתפקד. אבל התיעוד אינו חלק קריטי מהמוצר באותו מובן כמו רכיב חומרה או מודול בתוכנה. היות שמבחינה טכנית המוצר יכול לתפקד גם בלי תיעוד, מהנדסים מאבדים סבלנות כאשר לאחר תהליך פיתוח ארוך ומיגע המוצר מעוכב על ידי רכיב שאינו משפיע ישירות על תפקודו. זה נוטה לעצבן את המהנדסים.
אין פתרון ישיר לבעיה הזאת, אבל ניתן להקל עליה על ידי כיפוף מה של האקסיומה הראשונה. כדי לקצר את הפער בין סיום פיתוח המוצר וסיום פיתוח התיעוד, אפשר להתחיל לעבוד על התיעוד תוך כדי פיתוח המוצר. אבל אין זאת דרך יעילה להפקת מסמכים טכניים. תוכן התיעוד תלוי לגמרי במוצר. אם התיעוד לו יכול לחכות עד אשר המוצר מתייצב, המסמכים יצטרכו לעבור הרבה עדכונים לפני השלמתם. זה נוטה לעצבן את הכתבים הטכניים. מנקודת מבטם של המהנדסים, שינויים במוצר מוכתבים על ידי שיקולי פונקציונאליות והם לגיטימיים בהחלט. בשביל הכתב הטכני, שינויים במסמכים בעקבות שינויים במוצר הם מיותרים לחלוטין ומרגיזים; אם עבודה על פרק מסוים היתה מתחילה שבוע מאוחר יותר, לא היה צורך בכתיבה מחדש. נכון אומנם שאם הכתיבה הטכנית מתחילה מוקדם יותר התיעוד יושלם מוקדם יותר, אבל זמן הפקת התיעוד מתארך והמאמץ הכולל גדל בהשוואה למצב בו הכתיבה הטכנית מתחילה לאחר סיום פיתוח המוצר.
המתח בין לוחות הזמנים של פיתוח המוצר ופיתוח התיעוד הוא מקור למתחים בין מהנדסים לכתבים טכניים ומקשה על ניהל פרויקטים בכתיבה טכנית.
גבי לני
>a href="http://www.e-doc.co.il" title="כתיבה טכנית">אי-דוק תיעוד טכני</a<