Kas yra sąsajos valdymo dokumentas?

Sąsajos valdymo dokumentas (ICD) yra formalus metodų ir struktūrų, susijusių su konkrečios sistemos įvesties ir išvesties gavimu, aprašymas. Sistema, aprašyta sąsajos valdymo dokumente, gali būti programinės įrangos biblioteka arba techninės įrangos dalis. Dokumentas neturi būti vienodo formato, bet gali būti pastraipų, diagramų ar net tiesiog techninių sąsajos aparatinės įrangos brėžinių rinkinys. Konkrečiai kalbant apie programinę įrangą, sąsajos valdymo dokumentas gali būti panašus į abstrakčią programavimo sąsają (API), kuri apibūdina viešus metodus ar funkcijas, kurie gali būti naudojami informacijai įvesti į biblioteką, taip pat aprašo gaunamą išvestį. Sąsajos valdymo dokumente paprastai aprašoma, kaip integruoti sistemą į didesnę sistemą arba prijungti ją prie lygiagrečios sistemos; jis neaprašo jokio vidinio sistemos veikimo, kuris gali būti aprašytas atskiro tipo dokumente.

Sąsajos valdymo dokumento tikslas yra pateikti techninės ar programinės įrangos kūrėjams tam tikrą dokumentaciją, kuri gali būti naudojama kuriant sistemą ar programinę įrangą, kuri perduos duomenis į ICD aprašomą sistemą ir iš jos. Paprastai tai reiškia tikslių funkcijų ar aparatinės įrangos komponentų apibrėžimą taip, kad būtų žinomi jų parašai ir pateikiamos naudojimo parametrų leistinos nuokrypos. Programinės įrangos inžinerijoje tai gali reikšti, kad reikia žinoti konkrečios funkcijos pavadinimą, kokio tipo kintamieji priimami kaip parametrai ir, galbūt, kokios funkcinės ribos taikomos perduodamoms reikšmėms. Ši informacija gali apimti aparatinės įrangos dalį, kokias funkcijas atlieka nuosekliosios jungties valdymo kaiščiai, bet kokie naudojami aparatinės įrangos pertraukimai ir įrenginio darbo greitis.

Vienas dalykas, kurio sąsajos valdymo dokumentas konkrečiai neaprašo, yra tai, kaip sistema įvestį paverčia išvestimi arba apskritai kaip išvestis gaminama. Tai leidžia kūrėjams siaurai susitelkti į sistemą kuriant sąsają, tačiau taip pat reikalaujama, kad sistemos kūrėjai, kad TLK išsamiai pateiktų informaciją, griežtai laikytųsi pačiame dokumente išdėstytų gairių. Patogumas sąsajos valdymo dokumento rengėjams ir sistemos kūrėjams yra tai, kad dokumente nėra aprašytas vidinis sistemos įgyvendinimas, todėl gali būti laisvai keičiamas, nepažeidžiant išorinės sąsajų kūrimo, besiremiančios ICD.

Kai kuriais atvejais sąsajos valdymo dokumentas gali leisti testuoti sistemas iš tikrųjų nenaudojant užbaigtos sąsajos. Tai galima padaryti imituojant įvairius išvesties tipus, kuriuos sistema gali generuoti, kaip aprašyta ICD, ir perduodant tą išvestį per išoriškai sukurtą sąsają. Sistemos, kurios suinteresuotos valdyti tik vieną sistemos pusę, pvz., išvestį, jei tai aparatinė įranga, pvz., rodymo įrenginys, gali užtikrinti, kad sąsaja veiktų pagal specifikacijas, nereikalaujant realaus pasaulio įvesties.