המונח דוקומנטציה (באנגלית: Documentation) משמש לתאר תיעוד מידע, בעיקר בהקשר איך להשתמש באופן כללי במוצר מסוים כגון מכשיר חשמל או מוצר תוכנה.
דוקומנטציה יכולה להיות חוברת הדרכה (manual) בין אם "חוברת" זו תוכנתית (וירטואלית) או לא תוכנתית (נון-וירטואלית) או משני הסוגים יחדיו או מסמכי שאלה-תשובה ועוד.
דוקומנטציה בה הוסבר על שימוש במוצר מסוים לעתים כוללת פרק "בעיות ידועות" (known issues) או "שאלות הנשאלות בתכיפות" (frequently asked questions ובקצרה FAQ) המתאר מקרי-שימוש (usecases) ספציפיים העולים שוב ושוב, מעבר להסבר על שימוש כללי במוצר.
- לעתים אין הבדל ממשי בין המונח דוקומנטציה לבין המונח הכללי "תיעוד" (שגם כן יכול להיקרא "דוקומנטציה") וההבדל תלוי בעיקרו בהקשר
- שימוש בדוקומנטציה וירטואלית במקרים רבים עדיף על שימוש בדוקומנטציה מודפסת; הן בשל הפצתו החינמית והידידותית לסביבה בדרך כלל והן בשל היכולת הכללית להריץ בדוקומנטציה כזו פעולות חיפוש מידע ממוחשב
שפת דוקומנטציה
שפת דוקומנטציה אני מגדיר כשפת מחשב המשמשת לתיעוד מידע כתוב, ביעילות גבוהה ככל הניתן.
שפת דוקומנטציה מסוימת תהיה מיועדת לשימוש כללי או תהיה מיועדת לתיעוד ידע בתחום מסוים כגון מתמטיקה, כימיה, או פיתוח תוכנה ולפעמים מסמך ממוחשב יכלול תוכן שנוצר עם שניים או יותר שפות דוקומנטציה יחדיו.
דוגמאות
- שפת HTML (או שפות מבנה אחרות)
- שפת MediaWiki: שפת מחשב המתורגמת אוטומטית לשפת HTML ומאפשרת כתיבת ערכי לימוד
- שפת Markdown: שפת מחשב המתורגמת אוטומטית לשפת HTML ומאפשרת כתיבת מסמכים בנושאי STEM באופן כללי
- Latex: שפה לכתיב מדעי בכלל ומתמטי בפרט, לפי הידוע לי איננה מותאמת לעיוורים עדיין שכן הפלט שלה הוא תמונה
לא תמיד יש הבדל חד משמעי בין שפת מבנה לבין שפת דוקומנטציה ולמעשה שפות דוקומנטציה מסוימת (כמו MediaWiki או Markdown) משמשות לפיתוח מבני-מסמך בצורה מהירה ונוחה יותר מאשר עם שפת המבנה עצמה (אפילו ששפת המבנה עצמה מיועדת בעצמה לפיתוח דוקומנטציה).
