Um manual pode estar bem diagramado e ainda conter orientações incompatíveis com a obra. Os erros mais relevantes aparecem na correspondência entre o texto, os materiais instalados e os documentos de origem. A revisão deve testar essa correspondência antes da emissão.
1. Copiar um manual sem adaptar os sistemas
Um capítulo sobre equipamento inexistente ou acabamento diferente confunde o usuário. Antes de revisar frases, compare o índice com a relação dos sistemas do empreendimento. Exclua o que não se aplica e solicite dados para os sistemas ainda não descritos.
2. Usar especificações superadas
Alterações de obra podem não chegar à equipe que prepara os manuais. Estabeleça um responsável pela comunicação dessas mudanças e registre os arquivos que serviram de base ao texto. O nome “final” no arquivo não basta para confirmar sua liberação.
Uma verificação simples
Selecione alguns materiais e percorra o caminho completo: especificação confirmada, orientação no manual e anexo do fabricante. Essa amostragem ajuda a encontrar falhas de integração, embora não substitua a revisão integral dos itens contratados.
3. Inserir cuidados sem fonte identificada
Recomendações de limpeza ou manutenção precisam ser compatíveis com o produto. Uma instrução genérica pode contrariar o fabricante. Quando há dúvida, registre o ponto para validação técnica, preservando a origem da orientação utilizada.
4. Repetir prazos e exclusões de outra obra
As condições de garantia exigem análise própria. Não trate vida útil, prazo de garantia e prazo de atendimento como equivalentes. A redação também deve evitar afirmações de perda automática de toda garantia diante de qualquer falha de manutenção. Consulte a discussão específica sobre a NBR 17170 e os manuais.
5. Entregar anexos difíceis de localizar
Um link quebrado, um PDF sem identificação ou dezenas de arquivos com nomes semelhantes dificultam a consulta. Teste o material a partir da pasta que será entregue, não apenas do computador de quem diagramou. Informe a versão do manual e relacione os anexos efetivamente incluídos.
6. Encerrar a revisão com pendências invisíveis
Comentários dispersos em e-mails podem reaparecer depois da entrega. Consolide as pendências em um controle com decisão, responsável e versão afetada. Diferencie “recebido”, “conferido” e “aprovado”: são situações distintas.
Exemplo: o fornecedor envia o manual correto do automatizador de um portão, mas a identificação do acesso indicada no texto continua errada. A chegada do PDF não encerra a pendência de identificação. A conclusão deve considerar o resultado esperado, e não apenas o recebimento do arquivo.
A elaboração ou revisão dos manuais pela EngDoc pode contemplar esses controles conforme os documentos e as etapas definidos na proposta.
Referências consultadas
- ABNT Catálogo — NBR 14037 e NBR 17170.
- CBIC — atualização do guia de manuais. Os testes e exemplos descritos são recomendações práticas, sem promessa de eliminar ocorrências no pós-obra.