מה זה דוקומנטציה ואיך לקרוא אותה? שיעור 32
API DUCOMENTATION “ספר החוקים” שלנו לתקשורת נכונה עם הממשק של התוכנה. הדוקומנטציה נותנת לנו את כל המידע שאנחנו צריכים על מנת לגשת לפונקציונאליות השונה של אותה מערכת ואת הכלים לבצע מגוון פקודות שהמערכת מאפשרת לנו לבצע.
בעזרת הדוקומנטציה אנו נדע:
1. איזה פקודות אנחנו יכולים לבצע בתוך המערכת.
2. איך “לדבר” עם התוכנה בצורה נכונה כדי לבצע את הפקודות האלו (באיזה פורמט אנחנו צריכים להעביר פקודות) .
איך מגיעים לדוקומנצטיציה של מערכות:
- לינק בפוטר של האתר - "מפתחים" / "ממשק API" / API" / דוקומנטציה / תיעוד ( בעברית או באנגלית )
- חיפוש מהיר בגוגל של שם התוכנה לצד המילה API DUCOMENTATION
- בקשה משירות הלקוחות/ תמיכה - לרוב בצ'אטבוט באתרים הם מנגישים את הדוקומנטציה
- חיפוש המילה DUCOMENTATION בתוך המערכת