כתיבה טכנית – איך בוחרים בית תוכנה לתיעוד
“בית המקור” (המכונה גם עריכת “מובנית” או “תיעוד מובנים מבוססי XML”) היא מתודולוגיה התיעוד הטכני שדרכו מסמכים מרובים נוצרות מתוך סט יחיד של קבצי המקור.
מאת “מסמכים מרובים” אנו מתכוונים מסמכים מותאמים אישית, המותאמת עבור הבאות יעד קטגוריות:
1) מספר תפוקה בפורמטים: הספר המודפס; לעזור על שורת הקובץ: קובץ העזרה המובנה הבקשה; דף אינטרנט; הטלפון תוכן התא; וכו ‘
2) הקהל מספר: מנהלים, טכנאים בשטח, הציבור הרחב; מתקינים; במרכז מהנדסים מכנים, שיווק וצוות מכירות, וכו ‘
3) מספר יעדים USER ביצועים: מדריך התקנה, מדריך למשתמש, מדריך לפתרון בעיות; השתלמות בית; הדרכה אימון on-line, מנהל המדריך המערכת; וכו ‘
הנה דברים שאתה צריך לחפש אם אתה בשוק עבור תוכנה כזו …
באופן כללי, תוכנה יחיד המקור האידיאלי צריך להיות מסוגל ליצור מסמכים מתאימים לכל שלוש הקטגוריות היעד הנ”ל. זה אמור לספק “שימוש חוזר בתוכן” יכולת לא משנה מה את תבנית הפלט, הקהל, או ביצועים מטרות המשתמש. לכן מוצרים יחיד המקור היחיד להשתנות מבחינת המידה שבה הם יכולים לספק עריכה לשונית לאורך מעל לשלוש קטגוריות היעד.
לכל הפחות, תוכנות כאלה צריכים להיות מסוגלים פלט את המצגת הבאה “מרובות” קטגוריות, או פלט תבניות קובץ:
TXT, PDF, HTML, ולעזור (HTML, אינטרנט, ג ‘אווה).
התוכנה אמורה גם להיות מסוגל לעדכן את השינוי תוכן קובץ המקור אוטומטית בכל מספר קבצים שנוצרו ממנה.
אחד תכונה אחרת המסייעת יחיד המקור כותבים טכניים עסקה טובה היא היכולת להשתמש שוב פרטים נכתבו כבר על בסיס מודולרי על הנושא “” ברמה, דומה מאוד לטקסט “המסורתית סטנדרטי” המשמש הדפסה מבוססת שאינם מובנים מסמכים.
תכונה נוספת רצויה היא קישורים נבנה פונקציונליות “אריזה” זה בודק אם כל המולטימדיה או נושא / רכיבים התוכן חסרים, פגומים או שבורים לפני המסמך מובנה מיוצא פלטפורמה ספציפית בתבנית מסוימת. מוצרים יחיד המקור הכי ידוע לי כי הפונקציונליות ואת זה באמת עוזר במיוחד עבור פרויקטים תיעוד ארוך ומורכב הפועלים של אלפי עמודים ותרגום משפטי.