Novo Setor de Energia: Melhores Práticas de Documentação Técnica

Artigo

15 de dezembro de 2001

Em baterias e armazenamento de energia, a falha de documentação mais comum não é um erro de tradução. São versões linguísticas que se distanciam à medida que a linha de produtos vai à frente delas.

Uma especificação oficial por linha de produto

Os produtos de bateria e armazenamento iteram rapidamente e as linhas de produtos se expandem rapidamente, e o modo de falha mais comum não é uma tradução incorreta, mas versões de idiomas que se distanciam. A especificação chinesa passou por três revisões e a alemã ainda está na primeira; um cliente usando o arquivo errado é algo menor, um erro de instalação dele é um incidente.

A solução é manter uma especificação oficial por linha de produto e derivar dela todas as versões de idioma. Qualquer alteração é feita primeiro na origem e depois enviada. Isso parece evidente, mas a maioria dos arquivos das equipes está espalhada por dezenas de documentos e e-mails, e não há como saber qual deles é confiável.

A fonte única faz mais do que resolver a consistência: torna os preços de localização estimáveis. Quando a fonte é estável, a carga de trabalho de tradução é previsível. Quando a fonte muda diariamente, qualquer citação é fictícia.

Vincular versão do documento à versão do produto

A primeira linha de um documento deve indicar a qual versão de hardware e firmware ele corresponde. Novos produtos energéticos são revisados ​​com frequência e até mesmo o mesmo modelo pode apresentar diferenças de parâmetros entre lotes. Os clientes que instalam uma nova unidade com um manual antigo são uma fonte comum de disputa.

Vinculação significa que o número do documento contém o número da versão do produto, as alterações alteram a versão na etapa e há uma regra segundo a qual os documentos devem ser revisados ​​e traduzidos novamente quando a versão do produto é alterada. Essa regra deve ser definida no início do projeto e não renegociada após cada incidente.

A dificuldade de implementação geralmente é organizacional – a equipe que altera o produto e a equipe que gerencia os documentos muitas vezes não são as mesmas pessoas. É necessário algum mecanismo para que uma alteração de produto acione automaticamente a revisão do documento; observá-lo manualmente não funciona.

A documentação de segurança é um produto de primeira classe

Os produtos de bateria apresentam maiores riscos de segurança do que a maioria dos bens de consumo: fuga térmica, sobrecarga, requisitos de transporte e regras de instalação. Qualquer um deles escrito incorretamente pode causar um incidente com ferimentos pessoais. Portanto, os capítulos de segurança, as traduções de advertências e as declarações de conformidade não devem ser tratados em pé de igualdade com outros conteúdos; são resultados de primeira classe, programados, revisados ​​e arquivados separadamente.

Em projetos reais, esta seção é rotineiramente compactada, porque os capítulos sobre segurança são curtos e parecem simples. Os seus requisitos de revisão são, de facto, os mais elevados – a tradução não só deve estar correta, mas também corresponder à redação regulamentar do mercado-alvo. As declarações de advertência têm formulações designadas em diversas jurisdições, e uma pequena mudança na redação altera o significado legal.

Crie uma lista de verificação separada para documentação de segurança: cada idioma, cada requisito regulamentar, cada versão, assinalados um por um. Em um incidente, essa lista de verificação é a evidência mais forte.

Revisão por idioma: não pule esta camada

Os lançamentos de novas energias geralmente envolvem um bom número de idiomas, portanto a pressão de revisão é maior do que para um produto comum. Os revisores que entendem o domínio e o idioma de destino detectam problemas que os tradutores comuns e as verificações automatizadas não percebem — por exemplo, um termo com uma tradução especificada em um padrão local, um formato de unidade que não corresponde à convenção local ou uma frase cuja tradução literal inverte seu significado.

Quando a capacidade de revisão for curta, priorize a documentação de segurança e os principais idiomas do mercado e lide com o resto com níveis baseados em riscos. Abandonar totalmente a revisão não é uma opção: a tradução automática sem verificação humana acabará falhando em conteúdo regulamentado.

FangService possui recursos de revisão de domínio nos idiomas correspondentes para documentação técnica de novas energias, com arquivos de segurança e conformidade executados por meio de um processo de entrega de primeira classe. Traga o tipo de produto e os mercados-alvo e comece com um plano de classificação para um documento.

A parte mais difícil da documentação de armazenamento: um conjunto de dados, muitos leitores

Os projetos de armazenamento envolvem um número incomum de partes – o proprietário, o empreiteiro EPC, a empresa da rede, a equipe de operações, os revisores de incêndio. Eles olham para o mesmo sistema com prioridades completamente diferentes. A empresa de rede lê os parâmetros de conexão à rede e as configurações de proteção; operações lê códigos de falha e procedimentos de substituição; o proprietário lê os custos operacionais e os limites da garantia. Escrito como um manual técnico abrangente, o documento não serve a nenhum deles; escrito apenas para operações, a empresa da rede não o aceitará. O caminho é feito em camadas: as tabelas de parâmetros formam o documento mestre, cada função recebe seu próprio guia rápido, a numeração é consistente e toda a cadeia é atualizada em conjunto na revisão.

A sincronização de revisões é a segunda armadilha. Uma atualização de firmware BMS que adiciona e remove códigos de falha, se alterada apenas no manual mestre, deixa os guias específicos da função em uma versão mais antiga e o campo acaba procurando um novo firmware em uma tabela de códigos antiga. FangService vincula glossários e números de versão a esses projetos, cobre todos os documentos derivados no escopo de uma revisão e emite uma página de resumo de alterações para revisões importantes para que a equipe de operações do cliente possa atualizar o material de treinamento diretamente a partir dele.

A documentação técnica de ativos decide os custos do terceiro ano

A documentação de armazenamento de energia tem uma característica definidora: um longo ciclo de vida que abrange desenvolvimento, entrega e operações, com muitas partes e muitas versões. Projetos que tratam a documentação como uma entrega única acabam reescrevendo-a repetidamente no terceiro ano – as operações querem um novo formato, o cliente quer um novo modelo, um novo mercado quer uma nova linguagem e, a cada vez, o conteúdo é extraído de arquivos antigos.

Ativos significa projetar para reutilização desde o primeiro rascunho: estrutura consistente, módulos independentes, numeração estável, terminologia controlada, versões rastreáveis. Uma vez implementados, adicionar um idioma é multiplicar e adicionar uma função é combinação, em vez de reescrever. O tempo gasto na arrumação inicial retorna a cada reutilização subsequente.

FangService entrega a base de termos, a memória de tradução e as regras de controle de versão como parte do projeto, em vez de entregar e ir embora. O que o cliente recebe não são apenas traduções, mas um ativo que continua funcionando, que para uma equipe pequena muitas vezes vale mais do que um desconto no preço unitário.