Mikä on rajapinnan ohjausasiakirja?

Rajapinnan ohjausasiakirja (ICD) on muodollinen kuvaus menetelmistä ja rakenteista, jotka liittyvät syötteen syöttämiseen tiettyyn järjestelmään ja sen vastaanottamiseen. Käyttöliittymän ohjausasiakirjassa kuvattu järjestelmä voi olla ohjelmistokirjasto tai laitteisto. Asiakirjan ei tarvitse noudattaa yhtä muotoa, mutta se voi olla kokoelma kappaleita, kaavioita tai jopa vain liitäntälaitteiston teknisiä piirustuksia. Kun viitataan erityisesti ohjelmistoon, käyttöliittymän ohjausasiakirja voi muistuttaa ja abstrakti ohjelmointirajapinta (API), joka kuvaa julkisia menetelmiä tai toimintoja, joita voidaan käyttää tietojen syöttämiseen kirjastoon, ja kuvaa myös tulostetta. Liitäntäohjausasiakirjassa kuvataan yleensä, kuinka järjestelmä integroidaan suurempaan järjestelmään tai kytketään rinnakkaisjärjestelmään. siinä ei kuvata mitään järjestelmän sisäistä toimintaa, joka voitaisiin kirjoittaa erilliseen asiakirjatyyppiin.

Liitäntäohjausasiakirjan tarkoituksena on tarjota laitteiston tai ohjelmiston kehittäjille joitain asiakirjoja, joita voidaan käyttää luotaessa järjestelmää tai ohjelmistoa, joka siirtää tietoja ICD: n kuvaamaan järjestelmään ja sieltä. Tämä tarkoittaa yleensä tarkkojen toimintojen tai laitteistokomponenttien määrittämistä siten, että niiden allekirjoitukset tunnetaan ja käytettävien parametrien toleranssit on annettu. Ohjelmistotekniikassa tämä voi tarkoittaa tietyn toiminnon nimen tuntemista, millaisia ​​muuttujia hyväksytään parametreiksi ja mahdollisesti mitä toiminnallisia rajoja asetetaan välitetyille arvoille. Laitteiston osalta nämä tiedot voivat sisältää mitä toimintoja sarjaliitäntäohjaimen nastat, mahdolliset laitteiston keskeytykset ja laitteen nopeus.

Yksi asia, jota käyttöliittymän ohjausasiakirja ei tarkasti kuvaa, on se, miten järjestelmä muuntaa syötteen ulostuloon tai miten lähtö yleensä tuotetaan. Tämä antaa kehittäjille mahdollisuuden tarkastella kapeasti keskittynyttä näkökulmaa järjestelmään luodessaan käyttöliittymää, mutta se edellyttää myös, että järjestelmän kehittäjät, jotka käyttävät ICD -tietoja, noudattavat tiukasti itse asiakirjassa esitettyjä ohjeita. Liitäntäohjausasiakirjan kirjoittajille ja järjestelmän kehittäjille on kätevää, että järjestelmän sisäistä toteutusta ei ole kuvattu asiakirjassa ja sitä voidaan siten vapaasti muuttaa vaikuttamatta ICD: hen perustuvien rajapintojen ulkopuoliseen kehitykseen.

Joissakin tilanteissa käyttöliittymän ohjausasiakirja voi mahdollistaa järjestelmien testaamisen ilman, että todellisuudessa tarvitsee käyttää valmiita käyttöliittymiä. Tämä voidaan tehdä simuloimalla erilaisia ​​lähtöjä, joita järjestelmä voi tuottaa ICD: n mukaisesti, ja siirtämällä sitten ulostulo ulkoisesti kehitetyn käyttöliittymän kautta. Järjestelmät, jotka ovat kiinnostuneita käsittelemään vain järjestelmän toista puolta-kuten ulostuloa, laitteiston, kuten näyttölaitteen tapauksessa-voivat varmistaa, että rajapinta toimii vaatimusten mukaisesti ilman todellista syöttöä.