דוקומנטציה

מתוך הנקודאי

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

דוקומנטציה יכולה להיות חוברת הדרכה (manual) בין אם "חוברת" זו תוכנתית (וירטואלית) או לא תוכנתית (נון-וירטואלית) או משני הסוגים יחדיו או מסמכי שאלה-תשובה ועוד.

דוקומנטציה בה הוסבר על שימוש במוצר מסוים לעתים כוללת פרק "בעיות ידועות" (known issues) או "שאלות הנשאלות בתכיפות" (frequently asked questions ובקצרה FAQ) המתאר מקרי-שימוש (usecases) ספציפיים העולים שוב ושוב, מעבר להסבר על שימוש כללי במוצר.

הערות כלליות

  • לעתים אין הבדל ממשי בין המונח דוקומנטציה לבין המונח הכללי "תיעוד" (שגם כן יכול להיקרא "דוקומנטציה") וההבדל תלוי בעיקרו בהקשר
  • שימוש בדוקומנטציה וירטואלית במקרים רבים עדיף על שימוש בדוקומנטציה מודפסת; הן בשל הפצתו החינמית והידידותית לסביבה בדרך כלל והן בשל היכולת הכללית להריץ בדוקומנטציה כזו פעולות חיפוש מידע ממוחשב

ראו גם