O que é um documento de controle de interface?

Um documento de controle de interface (ICD) é uma descrição formalizada dos métodos e estruturas envolvidos no fornecimento de entrada e recebimento de saída de um sistema específico. O sistema descrito pelo documento de controle de interface pode ser uma biblioteca de software ou uma peça de hardware. O documento não precisa seguir nenhum formato único, mas pode ser uma coleção de parágrafos, gráficos ou mesmo apenas desenhos técnicos do hardware da interface. Ao se referir especificamente ao software, um documento de controle de interface pode se assemelhar e abstrair a interface de programação (API), que descreve os métodos ou funções públicas que podem ser usadas para inserir informações na biblioteca e também descreve a saída resultante. Um documento de controle de interface geralmente descreve como integrar o sistema em um sistema maior ou conectá-lo a um sistema paralelo; ele não descreve nenhum funcionamento interno do sistema, que pode ser explicado em um tipo separado de documento.

O objetivo de um documento de controle de interface é fornecer aos desenvolvedores de hardware ou software alguma documentação que possa ser usada ao criar um sistema ou software que irá transferir dados de e para o sistema que o ICD está descrevendo. Isso geralmente significa definir funções exatas ou componentes de hardware de maneira que suas assinaturas sejam conhecidas e as tolerâncias dos parâmetros de uso sejam fornecidas. Na engenharia de software, isso pode significar saber o nome de uma função específica, que tipo de variáveis ​​são aceitas como parâmetros e, possivelmente, quais limites funcionais são colocados nos valores passados. Para um pedaço de hardware, essas informações podem incluir quais funções os pinos de um controle de conector serial, qualquer interrupção de hardware usada e a velocidade de trabalho do dispositivo.

Uma coisa que um documento de controle de interface não descreve especificamente é como o sistema traduz entrada em saída ou como a saída é produzida, em geral. Isso permite que os desenvolvedores tenham uma visão restrita do sistema ao criar uma interface, mas também exige que os desenvolvedores do sistema detalhados pelo CDI sigam estritamente as diretrizes explicitadas no próprio documento. Uma conveniência para os redatores de um documento de controle de interface e os desenvolvedores do sistema é que a implementação interna do sistema não é descrita no documento e, portanto, pode ser livremente alterada sem afetar o desenvolvimento externo de interfaces que dependem do CDI.

Em algumas situações, um documento de controle de interface pode permitir o teste de sistemas sem realmente precisar usar uma interface completa. Isso pode ser feito simulando os vários tipos de saída que um sistema pode gerar como descrito no ICD e passando essa saída pela interface desenvolvida externamente. Os sistemas que estão interessados ​​apenas em lidar com um lado do sistema - como a saída, no caso de hardware como um dispositivo de exibição - podem garantir que a interface funcione dentro das especificações, sem a necessidade de entrada no mundo real.