Fabricante OEM/ODM de óculos inteligentes · Shenzhen, China +86 19835872450 sales@cynrin.com
OEM & ODM

Documentação do processo de desenvolvimento a ser guardada

A maioria dos problemas no fornecimento de óculos inteligentes não são de engenharia. O hardware é produzido, a linha funciona, as unidades chegam e algo continua errado: a…

Pela equipe de engenharia e sourcing da CYNRIN/ Jul 7, 2020/ 20 min de leitura
Documentação do processo de desenvolvimento a ser guardada

A maioria dos problemas na aquisição de smart glasses não são problemas de engenharia. O hardware é fabricado, a linha de produção funciona, as unidades chegam, e ainda assim algo está errado: uma alegação não pode ser comprovada, uma designação de modelo não corresponde a um documento, uma contestação de inspeção não tem um ponto de referência e ninguém consegue apresentar o registro que deveria resolvê-la. A lacuna quase nunca é uma máquina ausente. É um documento ausente.

Este artigo trata do conjunto de documentos que o comprador deve manter em cada etapa do framework de desenvolvimento CYNRIN. Aborda o que cada documento deve estabelecer, como organizar o arquivo para que sobreviva a uma mudança de equipe ou a uma auditoria e quais perguntas fazer sobre a própria documentação. Dá continuidade à visão geral do processo de desenvolvimento e complementa a descrição da etapa de design e prototipagem em design e prototipagem com o artigo complementar sobre como o desenvolvimento realmente funciona.

Documentação do processo de desenvolvimento: o conjunto de documentos etapa por etapa

O framework tem seis etapas, e cada uma delas gera um documento antes de produzir qualquer outra coisa. Uma etapa está concluída quando existe um documento assinado, e não quando chega a data. Esse é todo o princípio de organização do arquivo que você mantém.

O conjunto completo, na ordem das etapas:

  1. Requisitos congelados — o documento de requisitos assinado. Estabelece o mercado-alvo, os modelos abrangidos, a configuração, a embalagem, a documentação de entrega e, o mais importante, quais alegações o produto tem permissão para fazer. Este documento é a referência para todo o programa. Todos os documentos posteriores derivam dele.
  2. Viabilidade analisada — a resposta escrita de viabilidade. Indica se o pedido pode ser fabricado e qual o custo em engenharia e ferramentas. O resultado é um limite, não um veredicto: o que é comercialmente possível, o que exige investimento em engenharia e a data mais cedo em que uma resposta concreta poderá ser dada. "Sim" e "não" não são respostas úteis aqui.
  3. Engenharia e ferramentas — o acordo de ferramentas e a referência de compilação do firmware. O acordo de ferramentas registra quais ferramentas estão sendo produzidas, quem as possui, o que acontece com o custo delas se o projeto for interrompido neste ponto e como a propriedade muda caso o projeto continue. A referência de compilação do firmware identifica a compilação, sua versão e sua configuração de funcionalidades em relação aos requisitos congelados.
  4. Amostras fabricadas e verificadas — a amostra-padrão assinada e seu registro de verificação. A amostra-padrão é a referência física que define o que é aceitável e o que não é. O registro de verificação é a evidência escrita que abrange o pareamento, o áudio, o carregamento, eventuais funções da câmera e o comportamento dos controles.
  5. Arquivo de conformidade encerrado — a declaração de conformidade e os relatórios subjacentes. A declaração abrange a designação exata do modelo que será comercializado e se apoia nos relatórios que a sustentam e nos requisitos específicos de cada mercado. Uma declaração que cobre uma família de produtos, e não um modelo, não é uma declaração válida para o seu SKU.
  6. Produção-piloto antes da produção em massa — os critérios de inspeção e o registro da produção-piloto. Os critérios de inspeção são redigidos com base na amostra-padrão. O registro da produção-piloto é a evidência de que uma execução com ferramentas de produção, no volume de produção, passou nesses critérios.

Conjunto de documentação do processo de desenvolvimento nas seis etapas

Conjunto de documentos etapa por etapa e o artefato produzido em cada etapa

Além dessas seis, três itens adicionais completam o arquivo e são frequentemente omitidos porque ninguém os classifica como resultados das etapas:

  1. As aprovações da arte final e da embalagem. Molde, arte final para impressão, estrutura da caixa, rotulagem e arquivo mestre aprovado da arte final. Esses itens são assinados e versionados porque as alterações na arte final frequentemente ocorrem tarde, muitas vezes por motivos triviais, e um arquivo de arte final sem controle de versão em ambos os lados garante que a embalagem no armazém não corresponda à embalagem no desenho.
  2. O registro de pendências e desvios. Cada linha de requisitos que foi encerrada com base em um componente identificado, cada linha que não pôde ser encerrada e cada desvio em relação aos requisitos congelados, com uma aprovação para cada caso. Este é o documento que impede que o produto na linha de produção se desvie, sem ser notado, do produto que foi assinado.
  3. O registro de alterações. Qualquer alteração nos requisitos, na especificação, na compilação do firmware ou na arte final após o encerramento da respectiva etapa, com a data, o motivo, a aprovação e quais documentos subsequentes foram reemitidos por causa dela.

Observe o que está deliberadamente ausente dessa lista e por quê. Não publicamos capacidades de produção, durações de etapas, cronogramas indicativos, preços, níveis de MOQ, prazos de entrega, taxas de amostras, condições de garantia, números de certificados, tamanho da fábrica, número de funcionários e produção anual, e esses dados não fazem parte do conjunto documental deste referencial. Isso não é uma forma de ocultar condições comerciais; significa que esses dados pertencem ao conjunto deArtifacts de cotação e contrato, não a registros de engenharia. Eles devem constar da cotação, do pedido de compra e do contrato — e, ao avaliar um fornecedor, solicite-os diretamente como condições comerciais, em vez de esperar que apareçam em um dossiê técnico. Um fornecedor que não consegue cotar MOQ, prazo de entrega, incotermos e condições de garantia sem ressalvas está dizendo algo sobre sua operação comercial que nenhum documento de engenharia revelará.

O que produziremos em cada etapa será exatamente o documento purposejado para ela, em um formato que possa ser arquivado e referenciado: requisitos congelados em um documento de requisitos assinado; viabilidade analisada como um limite escrito; engenharia e ferramental consolidados em um acordo de ferramental e uma referência de compilação de firmware; amostras verificadas por uma amostra-padrão assinada e seu registro de verificação; conformidade encerrada com uma declaração delimitada pela identificação do modelo; e o piloto registrado segundo critérios de inspeção escritos. Quando um dado for comercial em vez de técnico, indicaremos a cotação correspondente em vez de inseri-lo no dossiê de engenharia, para que este continue legível como um registro de engenharia.

Fotografia gerada por IA ilustrando a documentação do processo de desenvolvimento que você deve guardar — imagem 1 de 3

O que cada documento de etapa deve resolver

O valor de um documento não está em seu tamanho, mas emwhether ele resolve uma questão que, de outro modo, seria resolvida pela memória, por suposições ou por quem estiver presente na sala.

O documento de requisitos define o que é o produto. Se tiver sido bem redigido, poderá ser verificado em relação a uma unidade entregue sem precisar perguntar nada a ninguém. Seu ponto mais frágil costuma ser a seção de alegações de marketing. Os compradores frequentemente escrevem os requisitos com foco em funcionalidades e se esquecem de registrar as alegações de marketing, descobrindo depois, durante a análise de conformidade, que uma alegação discutida em uma reunião nunca foi documentada e agora está na página do produto. As alegações devem constar no documento de requisitos, com uma declaração explícita sobre quais alegações o produto está autorizado a fazer. Uma alegação discutida verbalmente, mas não incluída nos requisitos congelados, reaparece durante a análise de conformidade, e reaparece no pior momento possível, pois, até então, arte, embalagem e unidades expedidas já dependem dela.

Um modo de falha relacionado é fácil de ignorar porque ocorre dentro da própria organização do comprador. O documento de requisitos costuma ser assinado pelo responsável pelo produto, enquanto a obrigação de conformidade recai sobre outra pessoa. O responsável pelo produto pode especificar uma funcionalidade. Somente quem responde pelo dossiê de conformidade pode especificar o que pode ser alegado sobre ela. Quando são pessoas diferentes, o documento de requisitos precisa conter uma seção de alegações claramente identificada e uma aprovação que inclua o responsável por conformidade, não apenas o responsável pela lista de funcionalidades. Se essa pessoa nunca vir o documento, a lista de alegações será elaborada na etapa de conformidade, quando a arte for aprovada e o texto de marketing redigido, resultando em atraso ou em uma alegação publicada sem aprovação. Este é um dos problemas mais baratos de resolver em todo o processo e um dos mais caros de corrigir tarde demais.

A resposta de viabilidade define o que é possível e qual seria a resposta mais rápida. Sua utilidade para o comprador está inteiramente em seus limites. Uma resposta de viabilidade que diz apenas "possível" não informa nada. O necessário é a divisão: o que já está disponível comercialmente, o que exige desenvolvimento de engenharia e o que não pode ser respondido até a realização de uma investigação específica. É nesta terceira categoria que os compradores costumam se perder, porque ela é formulada como uma data, e não como uma condição. A forma correta de interpretar uma resposta de viabilidade é como uma lista de dependências.

O acordo de ferramental define quem detém a titularidade do ferramental e o que acontece com seu custo se o projeto for interrompido. Este é o documento de maior impacto do dossiê e o que mais frequentemente fica implícito. O ferramental é onde o dinheiro é investido e representa a etapa menos reversível do programa: depois que o aço é cortado, a geometria fica definida, e todas as unidades seguintes são fabricadas conforme essa geometria. Três pontos devem constar no acordo: quem detém a titularidade do ferramental, o que acontece com seu custo se o projeto for encerrado nessa etapa e qual é o processo a ser seguido se o projeto continuar. Se a resposta para qualquer um deles for "discutiremos isso mais tarde", será nesse momento que o custo se tornará elevado.

A referência da versão do firmware determina qual software o produto executa. Um identificador de build, sua versão e a configuração de recursos devem ser expressos em relação aos requisitos congelados, de modo que qualquer pessoa possa ver o que está ativado, o que está desativado e quais são as configurações padrão. Sem isso, o firmware não é um objeto que possa ser preservado — é um estado que existiu em uma bancada, e a próxima conversa sobre um defeito se transforma numa discussão sobre qual versão estava em execução.

A amostra de referência e seu registro de verificação determinam o que significa aceitável. A amostra de referência é a referência física; o registro é o que a torna utilizável, porque captura a linha de base por escrito: comportamento de pareamento, saída de áudio e comportamento dos canais, comportamento de carregamento e indicação, qualquer função de câmera e seu comportamento de controle, além da linha de base cosmética observável. O registro também deve indicar a forma de custódia — onde a unidade é armazenada, quem tem acesso e em que condição ela deve permanecer para continuar sendo uma referência válida. Uma amostra de referência que ficou em um veículo quente não é mais uma referência, e ninguém informará isso a você.

A declaração de conformidade e os relatórios que a sustentam determinam o que você pode alegar e em qual mercado. A declaração deve abranger a string exata do modelo que será enviado. Uma declaração que cobre uma família de produtos, em vez de um modelo específico, não é uma declaração válida para o seu SKU, e essa é a distinção mais importante de todo o dossiê, porque a string do modelo é o que aparece no produto, na documentação, na remessa e no seu anúncio. Quando o seu catálogo contém mais de um modelo derivado da mesma plataforma, cada string de modelo enviado precisa de sua própria cobertura. Se o fornecedor oferecer uma declaração para uma família e você pretender enviar três SKUs, pergunte qual das três strings consta nela.

Forneceremos a declaração restrita à string exata do modelo, juntamente com os relatórios em que ela se baseia e os requisitos específicos de cada mercado que ela atende, e declararemos claramente quais mercados uma determinada declaração não cobre. Essa última parte é importante: um documento que informa o que não cobre é muito mais útil ao comprador do que outro que informa apenas o que cobre, porque o comprador que faz a segunda pergunta receberá de qualquer forma a primeira resposta.

Os critérios de inspeção e o registro da produção-piloto determinam o que um lote pode conter e se ele foi aprovado. Os critérios de inspeção são redigidos com base na amostra de referência, item por item, para que dois inspetores diferentes, em duas linhas diferentes, cheguem ao mesmo julgamento. O registro da produção-piloto é a evidência de que uma execução em ferramentas de produção, no volume de produção, foi inspecionada de acordo com esses critérios e foi aprovada. É aqui que substituições são detectadas: amostras de engenharia nunca revelam mudanças no fornecimento ou variações de processo, porque são montadas manualmente com a peça certa no lugar certo. Uma produção-piloto revela.

A arte final e as aprovações de embalagem determinam como será a embalagem. O dieline, a arte final, a caixa, a rotulagem e o arquivo mestre versionado. As aprovações de embalagem são uma fonte comum de alterações tardias e caras exatamente porque são consideradas triviais e, por isso, deixam de ser versionadas.

Camadas do conjunto documental retido e como se referenciam entre si

Lista de verificação da completude documental por etapa

Fotografia gerada por IA ilustrando a documentação do processo de desenvolvimento que você deve conservar — imagem 2 de 3

Como o dossiê é organizado

Um conjunto documental completo, mas inutilizável, vale menos do que um conjunto menor que alguém realmente consiga navegar. Três regras fazem a diferença entre um dossiê organizado e uma pilha de documentos.

Organize por etapa, não por data nem por tipo de documento. Cada etapa recebe uma pasta. Dentro dela, os documentos da etapa ficam juntos com as evidências de suporte da etapa. Uma estrutura baseada em datas obriga o leitor a reconstruir a qual etapa um documento pertencia, e essa reconstrução é exatamente o trabalho que você está tentando eliminar. Uma estrutura baseada em tipos — todas as especificações aqui, todos os relatórios ali — dispersa as evidências de uma etapa em quatro pastas e torna invisível o limite da etapa.

Todo documento tem um identificador, uma versão e uma data, e toda referência cruzada cita o identificador. Não o nome do arquivo, não a data, o identificador. Um documento de requisito que diz "conforme o build do firmware 2.3.1" e uma referência de firmware que diz "conforme o requisito CY-RQ-001" podem ser reconciliados em segundos. Dois documentos que dizem ambos "a versão mais recente" não podem ser reconciliados de forma alguma.

Todo documento contém uma aprovação. Nome, função, data e o que foi aprovado. Um documento sem aprovação é um rascunho que por acaso foi enviado, e a distinção se torna impossível de reconstruir depois de alguns meses, quando as pessoas já seguiram em frente.

Há mais uma convenção que se paga rapidamente, e é aquela que seguiremos em todos os arquivos de projeto que fornecemos: um índice curto na raiz do arquivo, uma linha por documento, mostrando o identificador, o título, a versão, a data e a etapa à qual pertence. Leva uma hora para manter e transforma o arquivo de algo que uma pessoa precisa navegar em algo que uma pessoa pode pesquisar. Auditores, gestores entrantes e clientes consultam primeiro o índice.

Uma estrutura viável tem este aspeto:

  1. Etapa 1 — Requisitos. O documento de requisitos assinado, a lista de alegações, as aprovações e a especificação da arte, caso a arte tenha sido solicitada nesta etapa.
  2. Etapa 2 — Viabilidade. A resposta de viabilidade com as suas três categorias de limites, a lista de dependências e as decisões tomadas.
  3. Etapa 3 — Engenharia e ferramentas. O acordo de produção de ferramentas, a especificação fabricável, a referência da compilação do firmware, o registo de itens em aberto com as respetivas resoluções e o registo de desvios.
  4. Etapa 4 — Amostras. O registo da amostra-padrão assinado, o registo de verificação, o acordo de custódia e as condições de aceitação do protótipo, incluindo as provas.
  5. Etapa 5 — Conformidade. A declaração de conformidade para cada cadeia de modelo expedido, os relatórios que a sustentam e a declaração de aplicabilidade ao mercado.
  6. Etapa 6 — Ensaio-piloto. Os critérios de inspeção, o registo do ensaio-piloto, as constatações e respetivas decisões e a decisão de libertação.
  7. Entre etapas. O registo de alterações, o registo de correspondência e o ficheiro comercial — cotação, ordem de compra e termos comerciais acordados, como MOQ, prazo de entrega, incoterms, garantia e peças de reposição.

Há mais dois aspetos práticos para manter isto utilizável. Primeiro, mantenha o arquivo num local que não seja a caixa de correio ou o portátil de uma única pessoa, porque o valor deste arquivo está precisamente em sobreviver à saída da pessoa que o compilou. Segundo, mantenha as provas no mesmo local da alegação. Uma declaração separada dos relatórios que a sustentam é uma declaração que não pode defender quando alguém pergunta porquê.

Um terceiro aspeto diz respeito aos itens físicos do arquivo, facilmente esquecidos quando tudo o resto é digital. A amostra-padrão é um objeto físico com uma função legal e precisa de um responsável nomeado, um local de armazenamento e uma verificação do estado com a regularidade que o seu sistema de qualidade já utilize para ativos de calibração ou de referência. O mesmo se aplica a uma segunda unidade retida do ensaio-piloto, que costuma ser a unidade de comparação mais útil que poderá ter, porque saiu de uma linha de produção real e não de uma bancada. Sempre que retiver uma unidade de produção para referência, registe qual era a cadeia de modelo e qual a compilação do firmware queustainha, porque uma unidade de referência sem esses identificadores não pode ser correspondida a nada.

Existe também o caso de um fornecedor que não trabalha desta forma. Algumas fábricas não produzem genuinamente documentos, e o seu output é bom. Esse é um estilo operativo legítimo, mas é um risco que deve precificar como tal, em vez de o descobrir mais tarde. O teste prático não é verificar se o fornecedor tem um departamento de documentação; é verificar se consegue obter as provas de que precisaria para defender uma expedição perante um cliente ou um inspetor. Se a resposta for que as provas existem, mas ninguém as escreveu, solicite-as como condição para continuar e compreenda que produzi-las é trabalho de engenharia com um custo. Se a resposta for que as provas não existem, o projeto não poderá encerrar a etapa de conformidade da forma pretendida, e deve saber disso antes de a produção de ferramentas ser comprometido, e não depois.

E o teste de organização é simples o suficiente para ser aplicado a qualquer momento: escolha aleatoriamente qualquer documento e pergunte o que ele esclarece e de que mais depende. Se a resposta demorar mais de um minuto, a estrutura falhou.

Fotografia gerada por IA que ilustra a documentação do processo de desenvolvimento que deve conservar — imagem 3 de 3

Perguntas a fazer sobre o conjunto de documentos

A documentação raramente é objeto de controvérsia no início de um projeto. Torna-se objeto de controvérsia quando a pressão comercial atinge o ponto máximo, normalmente perto do ensaio-piloto, e torna-se onerosa quando está ausente numa verificação aduaneira ou de entrada no mercado. Estas são as perguntas que vale a pena fazer, e a ordem importa menos do que o facto de as fazer antes de a pressão surgir.

  1. Podemos obter o conjunto de documentos, etapa por etapa, como está hoje? Um fornecedor com um processo operativo produz isto sem esforço. Um fornecedor sem esse processo encontrará razões para demora, e a razão será a resposta.
  2. Existe um documento de requisitos assinado e ele lista as alegações que o produto pode fazer? Não as funcionalidades — as alegações. Se não houver uma secção de alegações, essa é a lacuna a corrigir agora, num momento em que a alteração ainda é barata.
  3. Qual é exatamente a cadeia de modelo na declaração? Peça a cadeia e compare-a carácter a carácter com a cadeia de modelo que aparecerá no produto e na documentação. Peça cada SKU em separado, não a plataforma.
  4. De quem é a ferramenta de produção e o que acontece ao custo da ferramenta se pararmos neste ponto? Três perguntas numa só: titularidade, tratamento do custo e processo de continuação. A resposta deve constar de um acordo assinado, não de um e-mail.
  5. Qual é o identificador da compilação de firmware e a respetiva configuração de funcionalidades? Peça algo que possa ser verificado face aos requisitos, e não apenas um número de versão.
  6. O que abrange efetivamente o registo de verificação da amostra de referência? Deve abranger o emparelhamento, o áudio, o carregamento, eventuais funções de câmara e o comportamento dos controlos, com resultados medidos em vez de uma simples marca de aprovação.
  7. Onde está armazenada a amostra de referência e quem tem a sua custódia? Uma unidade de referência numa caixa de envio num armazém quente não é uma unidade de referência.
  8. Quais são os critérios de inspeção e foram estabelecidos com base na amostra de referência? Os critérios estabelecidos a partir de um desenho diferem dos estabelecidos com base numa unidade, e apenas um deles deteta desvios de fabrico.
  9. Qual é a versão de arte aprovada, e está versionada e assinada? Peça a referência do ficheiro principal de arte, não uma descrição do mesmo.
  10. Que alterações foram feitas depois de a respetiva etapa ter sido encerrada e os documentos posteriores foram reemitidos? O registo de alterações é o documento que revela divergências. Um fornecedor com um processo disciplinado responde a isto em minutos.
  11. O que não é publicado e o que devemos pedir em alternativa? Peça MOQ, prazo de entrega, incoterms, garantia, Custos de amostras e condições de peças suplentes como termos comerciais numa cotação. Peça provas de certificação para cada cadeia de modelo. Quando algo não estiver genuinamente disponível, pergunte o que o fornecedor precisa de si para o produzir.
  12. Uma nova pessoa do nosso lado consegue retomar este ficheiro e compreendê-lo? A forma honesta de testar isto é designar alguém que nunca tenha visto o projeto e pedir-lhe que responda a uma pergunta com base no ficheiro.

Vale a dois comportamentos do lado do fornecedor como positivos, porque são mais raros do que deveriam ser. O primeiro é fornecer a lista de pontos pendentes mesmo quando isso é desconfortável, o que demonstra que o trabalho de engenharia está a ser feito com base nos requisitos e não numa narrativa comercial. O segundo é delimitar explicitamente uma declaração a uma única cadeia de modelo, em vez de a estender a uma família, mesmo quando essa extensão teria sido conveniente.

Da nossa parte, trataremos o conjunto de documentos como parte da entrega, e não como documentação interna: cada etapa produz o respetivo documento antes de produzir o hardware, os documentos têm identificadores e versões e fazem referências cruzadas por identificador, e a etapa de conformidade é encerrada face à cadeia de modelo exata que será enviada. Se uma pergunta em qualquer fase não puder ser respondida com base no ficheiro, a resposta correta é dizer isso e produzir o documento em falta, e não responder verbalmente deixando o ficheiro incompleto.

Uma alegação discutida numa reunião, mas não registada por escrito, ressurge durante a revisão de conformidade. Uma declaração que abrange uma família em vez de um modelo não abrange o seu SKU. Estas duas frases são a razão pela qual vale a pena manter este ficheiro. Tudo o resto no conjunto é administrativo; estas duas são as que lhe custam uma entrada no mercado.

Para ver a sequência mais ampla e a relação entre as etapas, consulte a visão geral do processo de desenvolvimento. Para ver as etapas de qualidade e o que cada uma deve evitar, consulte as etapas de qualidade do processo de desenvolvimento. Para saber o que deve verificar antes de aceitar um envio face a este ficheiro, consulte a lista de verificação de certificação e conformidade.

Conversar no WhatsApp
A sua experiência neste site será melhorada ao permitir cookies.