Quais documentos o fornecedor de software industrial deve entregar na transferência? Lista do comprador

O sistema roda e os documentos não chegam: o que acontece depois?

Na reunião de transferência, documentos costumam ser tratados como papelada que sobrou. O sistema já está em uso, os operadores passaram pelas telas, e o restante fica para «a semana que vem». A semana vira um trimestre. Quando o time do projeto se dispersa, a única pessoa que explica uma tag, uma tabela ou o mapeamento de uma tela já não é responsável pelo site.

O prejuízo da falta de documentos não aparece no dia do aceite. Aparece depois, nas situações que toda fábrica encontra. Um software industrial — SCADA, MES, gestão de energia ou integração de linha — só se mantém na medida em que os documentos podem ser encontrados e lidos.

• O PLC foi trocado e uma tag precisa ser remapada, mas ninguém encontra o ponto de I/O ou o registrador que ela ocupava
• Um relatório de produção precisa ser alterado, mas ninguém registrou quais tabelas do banco ele lê nem qual regra de agregação usa
• O engenheiro original do fornecedor já saiu, e a fábrica não consegue treinar um operador novo com o material que realmente tem em mãos
• Um segundo contratado é chamado para expandir o sistema e precisa engenheirar de trás para frente endereços, telas e interfaces antes de começar
• Surge uma disputa de manutenção, e não há lista contínua nem relatório anual que mostre o que de fato foi feito

Essas cinco situações são o cotidiano depois do go-live, não acidentes raros. Os 14 tipos de documento existem para que troca de linha, troca de pessoal, integração posterior e revisão de manutenção continuem trabalho de rotina, em vez de virar arqueologia.

Quais 14 tipos de documento devem estar no pacote de transferência?

Um conjunto completo de documentos de projeto industrial tem 14 tipos: proposta do projeto, acordo técnico, especificação (memorial de especificação), tabela de alocação de I/O, tabela de alocação de endereços, diagrama de topologia de rede, especificação de projeto de telas, manual de operação, descrição das tabelas do banco, especificação de interfaces de dados, relatório de testes, material de aceite, lista de manutenção e relatório anual de manutenção. Listar nomes num monte não ajuda o comprador a conferir uma caixa. Agrupar pela pergunta que cada grupo responde, sim.

A tabela abaixo foi escrita para a reunião de transferência. A terceira coluna não é critério de saída de etapa; é o que olhar antes de assinar o termo de aceite.

Coloque esta lista no acordo técnico antes de começar o trabalho. Documento que não é nomeado na assinatura vira discussão depois que o time saiu, quando reconstruir é lento e a disputa é difícil de encerrar.

O que o comprador deve conferir antes de assinar a transferência?

Assinar o termo de aceite fecha o projeto para o fornecedor. Para a fábrica, abre o período em que os documentos precisam se sustentar sozinhos. As perguntas abaixo podem ser feitas uma a uma na reunião de transferência; se a resposta for «mandamos depois», aquele item ainda não foi entregue.

• Os 14 tipos estão nomeados no acordo técnico, ou o contrato só diz «documentação» sem lista?
• Cada documento nomeado é a versão as-built alinhada ao I/O, aos endereços, às telas e às interfaces instalados?
• Uma pessoa que não participou do projeto consegue seguir o manual de operação e completar um turno sem ligar para o fornecedor?
• O relatório de testes traz critérios, método, resultado e data, de modo que um terceiro consiga julgar aprovado ou reprovado?
• A descrição das tabelas do banco e a especificação de interfaces nomeiam tabelas, campos, direção dos dados e o responsável pelos dados mestres?
• A lista de manutenção e o relatório anual já estão num modelo utilizável, para o trabalho do ano seguinte ter uma base de comparação?
• Quem fica com os arquivos-fonte editáveis depois da transferência — a fábrica, ou só um PDF que o fornecedor retém?

A última pergunta é a que mais se pula. Um PDF assinado é registro. Uma tabela de I/O, uma tabela de endereços e um diagrama de rede editáveis são as ferramentas que a fábrica usa quando a linha muda. Registro e ferramenta são os dois; um não substitui o outro.

Em que idioma e em que formato os documentos devem ser entregues?

Documento que o operador não lê não será usado depois do go-live. Idioma é condição de transferência, não tradução para depois, e deve ser escrito ao lado de cada nome de documento no acordo técnico. Em plantas no Brasil, o combinado prático é português ou inglês, conforme o acordo.

O formato também decide se o documento continua utilizável. Um scan cheio de rasuras é registro. Uma tabela de alocação de I/O, uma tabela de endereços e um diagrama de topologia editáveis são ferramentas de campo. Os dois são necessários.

• Idioma de trabalho das reuniões e do contato permanente — janela em português (e inglês, se combinado) que acompanhe o projeto inteiro, não um intérprete que entra uma vez
• Idioma da especificação e do manual de operação — o idioma de quem vai usar (português ou inglês, conforme o acordo); arquivo só com capa traduzida e corpo em outro idioma não conta como entregue
• Formato de arquivo — fonte editável (planilha, desenho, documento) mais PDF assinado para arquivo; declare quais documentos devem vir nas duas formas
• Controle de versão — cada documento traz número de versão, data e marca que distingue o original de projeto da versão as-built

Escreva idioma e formato na mesma tabela dos nomes dos documentos. Fornecedor que consegue preencher essa tabela antes da assinatura já trata documentos como entregáveis, e não como papéis a juntar no fim.