Guia · Interfaces
Documento de controle de interfaces (ICD): o que ele contém e como mantê-lo atualizado
Ouvir este guia 20 min
Um documento de controle de interfaces registra o que atravessa a fronteira entre duas partes de um sistema e compromete as equipes dos dois lados com a mesma definição. Este guia trata do que um ICD contém, de quem é o responsável, de como encontrar as interfaces em primeiro lugar e de como manter o documento coerente com o projeto à medida que ele muda, com um exemplo prático de dois subsistemas de um pequeno satélite de observação da Terra.
Nesta página
- O que é um documento de controle de interfaces
- Quem é o responsável por um ICD
- O que um ICD contém
- Encontrando as interfaces na arquitetura
- Mantenha o ICD ligado ao modelo
- Controle de mudanças de interfaces
- Falhas comuns
- Exemplo prático: do C&DH às comunicações em um CubeSat
- Experimente no Holarch
- Para onde ir a seguir
O que é um documento de controle de interfaces
A maioria dos problemas de integração não está dentro de um subsistema; está na junção entre dois deles. Uma equipe supõe que o conector tem chaveamento de um jeito, a outra supõe o contrário. Um lado envia uma mensagem de status a cada 100 ms, o tempo limite do outro lado é 80 ms. Um documento de controle de interfaces existe para tornar essa junção explícita: ele declara, em um lugar com o qual os dois lados concordaram, o que passa entre eles e em quais condições.
Um ICD descreve uma interface de fora. Ele não diz como cada lado é construído, só o que cada lado precisa apresentar na fronteira: o conector e seus pinos, a tensão e a corrente, o formato e a temporização das mensagens, os pontos de fixação, o ambiente a que a interface precisa resistir. Cada equipe então projeta o seu lado para corresponder.
Três nomes de documentos relacionados costumam ser confundidos:
| Documento | Responde | Conteúdo típico |
|---|---|---|
| Especificação de requisitos de interface (IRS) | O que a interface precisa fazer? | Requisitos sobre uma ou mais interfaces, escritos como declarações verificáveis com “shall” antes de o projeto estar definido. |
| Descrição do projeto de interface (IDD) | Como um dos lados a implementa? | O projeto de uma interface como construída por uma das partes, muitas vezes um item de software ou hardware, com detalhes suficientes para construí-la e testá-la. |
| Documento de controle de interfaces (ICD) | Com o que os dois lados concordaram? | A definição controlada e aprovada em conjunto da interface entre duas partes específicas, colocada sob controle de mudanças. |
Os programas combinam esses documentos de formas diferentes. Alguns incorporam os requisitos ao ICD; outros escrevem um IRS cedo e depois um ICD quando o projeto amadurece. O que importa é que os requisitos e a definição acordada estejam ambos registrados, e que um deles seja claramente o que controla.
Quem é o responsável por um ICD
Um ICD tem duas partes, às vezes mais, e um único responsável. As partes são as organizações ou equipes responsáveis por cada lado: duas equipes de subsistema, um contratante principal e um fornecedor, uma equipe do veículo e uma equipe da carga útil. O responsável é a pessoa ou o grupo que mantém o documento, cobra os itens em aberto e conduz a aprovação. Em programas maiores, é um grupo de trabalho de controle de interfaces (ICWG): representantes de cada lado mais o engenheiro de sistemas responsável pela integração, reunindo-se com frequência regular.
Algumas regras de responsabilidade evitam a maioria das disputas:
- Um responsável por interface, nomeado no documento. “A equipe de sistemas” não é um responsável; um líder nomeado é.
- As duas partes aprovam. Um ICD assinado por um só lado é uma lista de desejos, não um documento de controle.
- O nível integrador é o responsável pelas interfaces entre seus filhos. A interface entre dois subsistemas pertence ao nível de sistema, porque nenhum dos subsistemas consegue resolvê-la sozinho.
- As interfaces externas, com equipamentos ou sistemas fora do programa, ficam sob responsabilidade do lado do programa e são acordadas com a parte externa, que pode ter seu próprio documento, com precedência.
O que um ICD contém
O roteiro exato depende do domínio e das normas do programa, mas um ICD completo cobre o mesmo terreno. Mantenha uma seção com “não aplicável” em vez de excluí-la, para que um revisor veja que ela foi considerada.
| Seção | O que registra |
|---|---|
| Identificação e partes | Número e nome da interface, as duas partes, o responsável, o status do documento e as aprovações. |
| Visão geral da interface | Um diagrama dos dois lados e de cada link entre eles, e uma declaração curta da finalidade da interface. |
| Lista de interfaces | Cada link individual (chicote, barramento, linha, tubulação, fixação) com seu próprio número, extremidades e status. |
| Mecânica e física | Pontos de fixação e padrões de furação, envelopes e zonas de exclusão, propriedades de massa na interface, alinhamento, tipos e posições dos conectores. |
| Elétrica | Atribuição de pinos, faixas de tensão e corrente, qualidade de energia, aterramento e ligação, blindagem, isolamento, níveis de sinal. |
| Dados e protocolo | Protocolos e camadas físicas, definições de mensagens com nomes de campos, tipos, faixas, unidades e escalas, identificadores, tratamento de erros. |
| Temporização | Taxas e períodos das mensagens, orçamentos de latência, sequências de partida e despertar, tempos limite e o que cada lado faz quando um deles expira. |
| Fluidos, térmica e óptica | Vazões, pressões e temperaturas na fronteira, calor transferido através dela, caminhos ópticos e campos de visão, onde se aplicam. |
| Ambiental | Condições de vibração, choque, temperatura, umidade, entrada de partículas e compatibilidade eletromagnética a que a interface precisa resistir. |
| Requisitos de interface | Os requisitos que a interface precisa satisfazer, cada um rastreado até seu requisito pai. |
| Verificação | Como cada requisito é verificado na interface (teste, análise, inspeção, demonstração), em qual nível e com qual equipamento. |
| Itens em aberto | Todo TBD (valor ainda não determinado) e TBR (valor proposto mas ainda não confirmado), cada um com um responsável e uma data de encerramento. |
| Histórico de mudanças | Cada revisão com sua solicitação de mudança, o que mudou e quem aprovou. |
Dados e temporização merecem mais detalhes
As interfaces mecânicas e elétricas costumam ser checadas fisicamente cedo, nas verificações de encaixe e na primeira energização. Incompatibilidades de dados e temporização sobrevivem muito mais tempo, muitas vezes até a integração do sistema, porque cada lado testa contra o próprio simulador, construído a partir da própria leitura do documento. Para cada mensagem, anote o identificador, o período e sua tolerância, o tipo, a faixa, as unidades e a escala de cada campo, a ordem dos bytes e o que o receptor faz quando a mensagem atrasa, falta ou está fora da faixa. Uma definição de mensagem que diz “corrente da bateria” sem unidades, convenção de sinal (carga ou descarga positiva) e resolução ainda não está controlada.
Verificando a própria interface
Os requisitos de interface são verificados como qualquer outro requisito (o guia da matriz de verificação de requisitos trata de métodos, níveis e evidências), mas a evidência tem um formato especial: ela precisa dos dois lados. Um teste de compatibilidade entre as unidades reais, ou entre uma unidade real e um emulador validado da outra, é mais forte do que dois testes separados contra duas leituras particulares do ICD. Planeje esses testes no ICD para que o equipamento e o cronograma existam quando forem necessários.
Encontrando as interfaces na arquitetura
Um ICD só consegue controlar as interfaces que alguém encontrou. A forma confiável de encontrá-las é a partir da arquitetura, não da memória.
- Comece pelas funções. Decomponha a missão em funções e suas entradas e saídas (o guia de análise funcional mostra como). Um diagrama N² coloca as funções (ou subsistemas) na diagonal; a célula na linha A, coluna B, contém o que A envia para B. Cada célula preenchida fora da diagonal é uma troca que precisa de um caminho. Aglomerados de células preenchidas mostram quais funções andam juntas; uma linha ou coluna cheia indica uma função da qual muitas outras dependem.
- Aloque as funções a componentes. Quando cada função é executada por uma parte física, toda troca entre funções em partes diferentes se torna uma troca que atravessa uma fronteira entre partes. O guia de arquitetura de sistemas mostra como essa alocação é feita e checada.
- Dê um caminho físico a cada troca que atravessa uma fronteira. Um chicote, um barramento, um link de rádio, uma tubulação ou uma junta mecânica. Uma troca sem caminho é uma lacuna no projeto; um caminho que não transporta nada é desnecessário ou ainda não foi entendido.
- Desenhe o diagrama de interfaces. Para cada par de partes, mostre os dois lados, suas partes internas na fronteira e cada link com o que ele transporta. Essa se torna a figura de visão geral do ICD.
Numere as interfaces à medida que as encontra. O exemplo prático abaixo numera seus links de IF-01 a IF-25 e dá a um link dentro de uma interface maior um decimal (IF-14.1 dentro de IF-14). Os números tornam as interfaces citáveis em requisitos, procedimentos de teste e solicitações de mudança, e mantêm uma lista de interfaces estável quando os nomes mudam.
Mantenha o ICD ligado ao modelo
Um ICD escrito como um arquivo de processador de texto isolado começa a se afastar do projeto no dia em que é aprovado. Um pino é reatribuído no desenho do chicote, um período de mensagem muda no software, um novo sinal é acrescentado por causa de um requisito tardio, e o ICD é atualizado semanas depois, ou nunca. Os revisores então comparam documentos entre si em vez de compará-los com o projeto.
A engenharia de sistemas baseada em modelos inverte isso. Cada interface é um elemento do modelo do sistema, conectado às suas duas extremidades, aos itens que transporta e aos requisitos que a regem. O ICD é um relatório gerado a partir desses elementos. Assim:
- O mesmo link aparece com os mesmos valores no ICD, no diagrama de interfaces, no rastreamento de requisitos e na matriz de verificação, porque todos leem uma única definição.
- Uma mudança na taxa de uma mensagem ou em um conector aparece no próximo ICD gerado, e o histórico de mudanças vem do próprio registro do modelo.
- As checagens são executadas sobre o modelo: uma troca entre duas partes sem link que a transporte, um link com uma só extremidade, um link cuja carga excede sua capacidade, um link sem responsável ou status.
- Os requisitos sobre uma interface são rastreados até ela, para que as seções de requisitos e de verificação do ICD fiquem completas (veja o guia de rastreabilidade de requisitos para tipos de vínculo e checagens de lacunas).
Nem tudo cabe nos atributos do modelo. Desenhos detalhados de conectores, diagramas de temporização e catálogos longos de mensagens podem ficar em documentos anexados ou referenciados. O modelo continua contendo a interface, seu status, seu responsável e a referência, para que o ICD gerado aponte para a revisão certa.
Controle de mudanças de interfaces
A definição de uma interface amadurece em etapas, e a etapa decide como uma mudança é tratada. Um esquema simples de quatro etapas funciona para a maioria dos programas:
| Status | Significado | Como uma mudança é feita |
|---|---|---|
| Draft | A primeira definição de um dos lados. | O responsável a edita livremente. |
| Proposed | Oferecida à outra parte para revisão. | As mudanças são discutidas no grupo de trabalho e registradas. |
| Agreed | As duas partes a aceitam; os projetos podem avançar com base nela. | Uma mudança precisa do consentimento das duas partes e de uma declaração de impacto para cada lado. |
| Baselined | Parte de uma linha de base de configuração aprovada. | Uma solicitação de mudança formal, avaliada e aprovada pelo comitê de mudanças, com o ICD reemitido. |
Uma cadência comum é ter as interfaces esboçadas até a revisão de requisitos do sistema, acordadas antes da revisão preliminar de projeto e colocadas na linha de base antes da revisão crítica de projeto. Seja qual for a cadência, uma solicitação de mudança contra uma interface na linha de base deve declarar o motivo, os links e itens afetados, o impacto no projeto, no custo e no cronograma de cada parte, os requisitos e a verificação afetados e a efetividade: a partir de qual build ou número de série a mudança se aplica. Como encontrar e dimensionar esses efeitos é mostrado passo a passo no guia de análise de impacto de mudanças.
Acompanhe os TBDs e TBRs como uma lista que precisa diminuir. Uma interface que ainda está cheia de itens em aberto na revisão crítica de projeto é um risco de cronograma, diga o que disser o seu status.
Falhas comuns
- Interfaces que ninguém encontrou. Uma troca entre funções nunca recebeu um caminho físico, ou uma interface externa (equipamento de solo, equipamento de teste, o operador) ficou de fora. Monte a lista de interfaces a partir da arquitetura, não da lista de chicotes.
- Documentos de um lado só. Uma equipe escreve o ICD, a outra nunca concorda formalmente, e a divergência aparece na integração. Exija as duas aprovações antes de um status Agreed.
- Unidades e convenções ausentes. Um valor sem unidades, convenção de sinal, ordem dos bytes ou escala abre espaço para duas leituras diferentes. Trate cada um como um defeito na revisão.
- Carga não comparada com a capacidade. Cada mensagem cabe, mas juntas excedem o barramento; cada carga cabe no chicote, mas juntas excedem sua especificação. Some as cargas de cada link e compare com sua capacidade, com margem. No modelo de exemplo abaixo, IF-05 Payload Interface transporta uma faixa de imagem de 480 Mbps mais uma programação de comandos de 0,02 Mbps em um link de 400 Mbps: 480,02 de 400 Mbps, 120 %, sinalizado pelo modelo antes da integração em vez de descoberto na bancada.
- Temporização deixada implícita. As taxas são informadas, as tolerâncias e o comportamento de tempo limite não. Registre os dois e o que cada lado faz quando o outro atrasa.
- Cópias desatualizadas. O ICD, o desenho do chicote e a tabela de mensagens do software guardam cada um sua própria versão. Gere a partir de uma única fonte, ou ao menos diga qual delas controla.
- Itens em aberto sem responsável. Um TBR sem uma pessoa e uma data continua em aberto. Dê os dois a cada um.
- Verificação planejada tarde demais. Os testes de interface precisam do hardware dos dois lados ou de emuladores validados. Planeje-os quando o ICD for acordado, não quando as unidades chegarem.
Exemplo prático: do C&DH às comunicações em um CubeSat
O exemplo é o EO-1, um CubeSat 6U de observação da Terra que fotografa terras agrícolas a partir de uma órbita heliossíncrona de 500 km; o guia do projeto de exemplo de MBSE percorre o modelo inteiro. Aqui pegamos uma junção dentro da espaçonave: entre 1.4 C&DH (comando e tratamento de dados, um computador de bordo com 64 GB de armazenamento para a carga útil) e 1.5 Communications (o 1.5.1 UHF Transceiver para comandos e o 1.5.2 S-band Transmitter para os dados da carga útil). Equipes diferentes constroem os dois lados, e todo comando que o satélite executa e toda imagem que ele envia ao solo atravessa essa fronteira.
Encontrando as trocas
A passagem nominal de imageamento do modelo, OPS Run Nominal Imaging Pass, é decomposta em doze funções, de OPS.1 a OPS.12, e onze delas estão alocadas ao ativo que as executa. Seu diagrama N² as coloca na diagonal e os itens que elas trocam nas células:
Duas células atravessam a fronteira entre C&DH e Communications:
- Linha OPS.2 Receive Imaging Plan (executada pelo UHF Transceiver), coluna OPS.3 Load Command Schedule (executada pelo C&DH): Command Packets, os pacotes de comando decodificados vindos do rádio.
- Linha OPS.7 Encode and Store Image (C&DH), coluna OPS.8 Transmit Image Data (o S-band Transmitter): Downlink Frames, dados de imagem comprimidos e empacotados.
Uma terceira troca não aparece nesta passagem porque vem da lógica de modos da espaçonave: a ação de entrada do C&DH Enable S-band Transmitter envia um Transmitter Enable Command para F9 Transmit Payload Data, executada pelo S-band Transmitter. Uma lista de interfaces montada a partir de um único cenário a teria deixado passar, e é por isso que as funções são alocadas a ativos no modelo inteiro antes de as interfaces serem listadas.
Os links e o que eles transportam
A demonstração já dá a cada troca um caminho físico. Para fazer delas uma única interface controlada, acrescentamos um só elemento ao projeto de demonstração: um conduit pai, IF-26 C&DH to Communications Interface, conectado aos dois subsistemas, com status Agreed, responsável Comms Lead e os dois links existentes como filhos. Todo o resto abaixo é a demonstração como ela vem.
| Link | Extremidades | Meio e conector | Transporta | Capacidade | Status |
|---|---|---|---|---|---|
| IF-07 Radio Command Interface | UHF Transceiver → C&DH | UART, 115,2 kbaud; J3 (Micro-D 9) | Command Packets, 0,0096 Mbps (9,6 kbps) | 0,1 Mbps | Baselined |
| IF-08 Payload Data Interface | C&DH → S-band Transmitter | SpaceWire; J4 (Micro-D 9) | Downlink Frames, 10 Mbps; Transmitter Enable Command, sem taxa definida | 100 Mbps | Agreed |
Cada link é rastreado até o requisito que o motiva: IF-07 satisfaz 5.2 UHF Command Uplink (“The UHF transceiver shall receive ground commands at 9.6 kbps”), e IF-08 satisfaz 5.1 S-band Downlink Rate (“The S-band transmitter shall downlink payload data at 10 Mbps”).
O diagrama de interfaces
O diagrama de controle de interfaces mostra as duas partes como faixas, a interface pai no meio, cada link como uma barra com seu status, sua capacidade e seus itens, e uma linha de cada link até a parte que ele conecta:
A faixa do C&DH não tem partes porque o modelo trata o computador de bordo como uma unidade: os dois links terminam no próprio C&DH. No lado de Communications, cada link termina em um rádio diferente, que é exatamente o que a equipe de chicotes precisa saber.
O ICD gerado
O ICD é exportado a partir dos mesmos elementos como um documento do Word. A primeira página contém o registro de interfaces e um resumo de status; cada conduit recebe então sua própria seção com extremidades, conector e pinos, meio, itens transportados com direção e taxa, os requisitos vinculados e a checagem de capacidade.
Baixe o ICD: ICD do EO-1 para a interface entre C&DH e Communications (.docx), o documento completo de três páginas como o Holarch o exportou, sem a data de exportação. Ele contém apenas os dados fictícios da demonstração EO-1.
O que o exemplo mostra
- O registro é a pauta do grupo de trabalho. IF-07 está na linha de base, então uma mudança nele passa por uma solicitação de mudança. IF-08 está acordado: uma mudança ainda precisa da equipe de C&DH e da equipe de Communications. Nenhum dos dois tem TBD ou TBR em aberto, então esta interface está pronta para entrar na linha de base como um todo.
- Cheque a capacidade em relação ao que o meio realmente entrega. IF-07 transporta 9,6 kbps em uma capacidade registrada de 0,1 Mbps, que o documento informa como 10 %. Uma UART a 115,2 kbaud com um bit de início e um de parada por byte move 115.200 × 8 / 10 = 92.160 bit/s de dados, então a capacidade real é de cerca de 92 kbps e a carga é de cerca de 10,4 % dela. A margem é grande de qualquer forma, mas o valor registrado arredonda para cima; em um link mais carregado, esse arredondamento esconderia um problema.
- Um link pode passar enquanto o sistema falha. IF-08 leva 10 Mbps de quadros por um link SpaceWire de 100 Mbps, 10 % da capacidade. A restrição está uma interface adiante: IF-12 S-band Downlink transporta 9,6 Mbps em um link de rádio de 10 Mbps, 96 %. Um fluxo de quadros mais rápido passaria facilmente por IF-08 e falharia na antena, então uma revisão de ICD olha para a cadeia, não para um link.
- Um item sem taxa não é checado. O Transmitter Enable Command não tem taxa de dados, então a checagem de capacidade o deixa de fora. Ele é minúsculo, mas um valor vazio é um item em aberto: dê a ele uma taxa, ou um TBD com responsável.
- A interface pai não tem capacidade própria. Ela agrupa os itens de seus links (três aqui) e dá ao par de partes um documento, um responsável e um status; as checagens de carga são feitas em cada link.
- Uma mudança é rastreável. Se a missão passar a um downlink mais rápido, a taxa de Downlink Frames muda em um só lugar, as checagens em IF-08 e IF-12 são executadas de novo, e o requisito 5.1, rastreado até IF-08, indica o que verificar de novo.
Experimente no Holarch
- Crie a demonstração com Gerenciar projetos → Arquivos de projeto ▾ → Novo projeto de demonstração → CubeSat (engenharia de sistemas guiada).
- Abra Interfaces → Diagramas N² e abra o diagrama N² da ação OPS Run Nominal Imaging Pass para ver as trocas entre suas funções.
- Abra Interfaces → ICDs, clique em + Novo diagrama e escolha C&DH como ativo pai da esquerda e Communications como o da direita.
- Arraste os conduits existentes IF-07 Radio Command Interface e IF-08 Payload Data Interface da paleta para a caixa central. Seus itens e conexões vêm junto.
- Selecione um link para revisar Interface Status, Proprietário, TBD/TBR, Capacity e Unidades, e seus requisitos vinculados.
- Clique em Exportar documento ICD para o documento do Word, ou em Exportar ICD (CSV) para uma tabela.
Interfaces → Registro de interfaces lista todas as interfaces do projeto com seu status e a checagem de capacidade; na demonstração, mostra IF-05 acima da capacidade. As instruções passo a passo estão em produzir um documento de controle de interfaces; interfaces na linha de base mudam por meio de solicitações de mudança.
Para onde ir a seguir
- Interfaces no Holarch: o registro de interfaces, checagens de capacidade e ICDs a partir do modelo.
- Documentação de interfaces: conduits, itens, o diagrama de controle de interfaces, diagramas N² e de E/S física.
- Documentação de solicitações de mudança: controle de configuração para itens na linha de base.
- O que é MBSE?: por que os engenheiros mantêm o sistema em um modelo.