Criando um Documento de Requisitos de Engenharia (ERD) Eficaz: Guia Passo a Passo

Um documento de requisitos de engenharia (ERD) é uma declaração descrevendo o objetivo e propósito de um novo componente. Diferente de um documento de requisitos de produto (PRD), que diz aos engenheiros o que precisam construir, um ERD especifica por que uma peça está sendo construída e como seu design alimenta seu propósito. Seguindo os requisitos de engenharia descritos em um ERD, engenheiros podem garantir que a peça que construírem satisfará necessidades do cliente. Usar um ERD também ajuda a agilizar produção de várias formas:

• ERDs usam comunicação definida e consistente para promover colaboração, reduzir má comunicação e manter todos na mesma página.
• ERDs ajudam a dividir grandes projetos em tarefas menores, tornando-os mais fáceis de delegar ou terceirizar.
• ERDs podem ser verificados contra PRDs para garantir que todas as intenções de design são implementadas corretamente e todos os objetivos de produto alcançados.

Um ERD bem escrito permite que engenheiros e fabricantes respondam perguntas críticas sobre design e propósito da peça sem idas e vindas. Isso resulta em processo de construção mais rápido e eficiente que economiza tempo e dinheiro. Aqui está tudo o que você precisa saber para escrever um ERD claro e eficaz.

Critérios padrão para um documento de requisitos de engenharia

Para começar, todos os ERDs eficazes têm os seguintes seis elementos em comum:

Clareza

Todos os requisitos de engenharia devem ser claros, curtos e inequívocos para evitar confusão. Menos é mais — frequentemente, uma descrição de uma frase basta.

Necessidade

Para evitar confusão ou contradições, coloque apenas requisitos absolutamente essenciais no seu ERD. Determine o pior cenário para cada requisito e se não houver consequências, não há necessidade de incluí-lo.

Coordenação

Requisitos de engenharia devem ser corretos durante todo o design do produto. Um ERD deve descrever todos os requisitos, objetivos, condições e capacidades do produto. Sempre que possível, explique o que o produto faz de forma numérica para maior precisão.

Testabilidade

Sempre que escrever um novo requisito, você deve ser capaz de verificar implementação bem-sucedida. Existem muitos métodos de teste para garantir verificabilidade, incluindo inspeção, teste de usuário, teste de software e teste de integração de sistema. Escolha o método que faça mais sentido para seu projeto.

Viabilidade

Mantenha-se dentro dos limites do que pode ser alcançado tecnicamente, bem como legal, organizacional e financeiramente. Seja razoável e honesto, já que criar requisitos não viáveis causará complicações. Se viabilidade não puder ser atingida, você pode declarar um detalhe de design como objetivo em vez de requisito.

Rastreabilidade

Qualquer engenheiro olhando seu ERD deve ser capaz de rastrear cada requisito de volta ao propósito original do produto. Vincular implementações a objetivos ajuda a explicar por que um elemento é importante, de onde vem e como faz sentido com o design geral.

Dicas para escrever um bom documento de requisitos de engenharia

Uma vez que você garantiu que os critérios padrão foram contabilizados, pode implementar melhores práticas que levarão seu ERD ao próximo nível. Aqui estão cinco dicas para escrever um ERD de alto nível.

Use um modelo de documento de requisitos de engenharia

Você pode economizar tempo e energia no início de um novo projeto usando um modelo de ERD. Um modelo garante que seu ERD seja sempre estruturado corretamente. No mínimo, deve ter página de capa, títulos de seções e outras seções padronizadas conhecidas como "boilerplates". Use boilerplates para cobrir tópicos como uso de verbos, abreviações, palavras-chave, padrões de formatação e outras diretrizes necessárias para entender seu ERD.

Evite escrever operações e implementações

Seus requisitos de engenharia devem declarar um objetivo, não como o objetivo será alcançado. Se você explicar passos para completar um propósito em vez do propósito em si, não está escrevendo um ERD — está escrevendo guia de operações e implementações. Se escrever um guia de operações por engano, um fabricante pode mal interpretar suas intenções e objetivos do projeto podem não ser atingidos.

Para garantir que seus requisitos são de fato requisitos, pergunte a si mesmo por que este requisito é necessário no seu ERD. Confie que designers de sistemas e fabricantes determinarão como o objetivo será alcançado e farão da forma mais eficiente possível.

Avalie seu ERD

Isso ajudará a verificar se todos os requisitos atendem seus objetivos declarados e aspirações da empresa. Para avaliação bem-arredondada, é melhor montar equipe diversa. Isso inclui trazer pessoas de todas as raças, etnias e gêneros para avaliar seu ERD, mas também inclui trazer diversidade de funções. Inclua quantas funções puder — designers, desenvolvedores, testadores, representantes de usuários finais, responsáveis por manutenção e gestão, e claro a equipe do cliente — para trazer insights valiosos à avaliação.

Use a linguagem correta

Existem regras de linguagem que você deve sempre seguir ao escrever um ERD. Os três grandes termos específicos são "deverá" (shall), "irá" (will) e "deveria" (should). "Deverá" representa requisitos, "irá" representa fatos, e "deveria" representa objetivos.

Um termo específico frequentemente mal usado é "suporte". Em termos de ERD, "suporte" referencia a capacidade de uma estrutura de segurar ou suportar peso, não que suportará ou realizará certas capacidades.

Em geral, evite termos como "são", "é" e "era" nos próprios requisitos. Pode usá-los em seção descritiva ou introduzindo um requisito, mas evite no requisito em si para promover especificidade. Também evite termos vagos como:

• "Mas não limitado a" ou "etc." — Estes cobrem o desconhecido e não deve haver nada desconhecido ou imprevisível no seu ERD.
• "E/ou" — Deixa muitas opções para interpretação e margem para erro porque um contratado estará certo em dois cenários (se escolher E ou se escolher OU).
• Palavras fracas sem significados quantitativos. Inclui adjetivos como "poderoso" e "eficiente" e verbos como "aprimorar" ou "fortalecer". Também evite comparações (rápido ou lento, mais ou poucos) e outra linguagem não quantitativa.

Ao escrever ERDs, também evite declarações negativas e foque na existência de elemento ou capacidade de um requisito. A única vez aceitável para usar especificações negativas é ao enfatizar situação potencialmente perigosa. Mesmo nestas instâncias, certifique-se de declarar o caso de segurança também.

Não seja excessivamente específico

Embora existam muitas regras de linguagem, mantenha simples. Clareza é chave para ERDs, então foque apenas nos objetivos, restrições e metas necessários. Sempre tenha razão para colocar um requisito — muitos requisitos confundirão leitores. Se sentir seus requisitos ficando longos e complicados, use marcadores para dividir seus elementos.

Ter um ERD bem escrito ajudará engenheiros, equipes de produto e outros colaboradores a entender melhor suas intenções de design. Conectando claramente o design de um componente a seus objetivos específicos e propósito geral, um ERD garante que um produto é construído de forma a satisfazer necessidades do cliente.

Mais importante, um excelente ERD promove colaboração, comunicação e clareza durante todo o processo de design e fabricação. Isso garantirá que cada peça seja totalmente funcional e completará seus objetivos. Junto com consistência peça a peça, um ERD também promove produções mais rápidas e custos menores.

Seja escrevendo seu primeiro ERD ou já experiente, a Fast Radius está aqui para ajudar em cada estágio do desenvolvimento e produção. Nossa equipe de designers, engenheiros e fabricantes especialistas está aqui para garantir que sua peça alcance todos seus objetivos. Entre em contato hoje.

Para mais recursos sobre desenvolvimento de produto, visite o centro de aprendizado da Fast Radius.

Pronto para fabricar suas peças com a Fast Radius?

Solicite seu orçamento