Escrevendo uma especificação técnica

Uma especificação técnica é um documento que define um conjunto de regulamentos que um produto ou montagem deve cumprir. Um produto ou conjunto que não atende a todos os requisitos formulados especificamente não atende à especificação e é frequentemente chamado de `fora de especificação`. As especificações são usadas quando um contrato para produtos ou serviços técnicos é emitido. A especificação técnica define os requisitos do contrato de venda. Use estas dicas para aprender a escrever uma especificação técnica.

Degraus

Parte 1 de 3: Revisando Considerações Gerais

Imagem intitulada Escreva uma especificação técnica Etapa 1
1. Decida se a especificação deve ser aberta ou fechada.
  • Considere uma especificação aberta. Uma especificação aberta descreve o desempenho requerido sem impor como ele deve ser alcançado. Uma especificação aberta deixa muita liberdade para a entidade que fabrica um produto ou faz uma montagem para atender às especificações. Por exemplo, uma especificação do tamanho da memória de um computador não especifica o meio exato que deve ser usado para armazenar os dados para atender a esse requisito.
  • Considere uma especificação fechada. Uma especificação fechada descreve não apenas o desempenho exigido, mas também as ferramentas, tecnologias ou peças que devem ser usadas no projeto de um produto ou montagem, a fim de atender à especificação. Por exemplo, uma especificação de um dispositivo de elevação pode exigir que a força hidráulica seja usada pelo produto ou conjunto para atender às especificações.
Imagem intitulada Escreva uma especificação técnica Etapa 2
2. Defina os requisitos. Considere todas as especificações para determinar se elas são necessárias para o produto ou montagem.
Imagem intitulada Escreva uma especificação técnica Etapa 3
3. Tenha um estilo de escrita claro.
  • Use frases curtas e diretas.
  • Evite usar `it` ou `that` e indique claramente o que é referido no texto.
  • Definir jargão e abreviaturas da indústria. Para fornecer uma definição clara dos termos industriais, adicione uma seção de definições no início da especificação.
  • Imagem intitulada Escreva uma especificação técnica Etapa 4
    4. Criar um índice. Organize o conteúdo de forma que os requisitos gerais sobre o produto ou montagem sejam apresentados primeiro, seguidos por subseções mais específicas ou especificações de submontagem.

    Parte 2 de 3: Criando a especificação

    Imagem intitulada Escreva uma especificação técnica Etapa 5
    1. Liste todos os requisitos que devem ser atendidos pelo produto ou conjunto. Use a palavra `deve` se quiser indicar um requisito. As condições expressas como `devem` devem ser completa e adequadamente atendidas. Considere o seguinte e adicione outros fatores conforme exigido pelo produto ou conjunto para atender às necessidades da especificação.
    • Decidir sobre as dimensões e/ou peso aceitáveis ​​do produto.
    • Indique toda a gama de condições que o produto ou conjunto deve atender de acordo com a especificação. Se o desempenho reduzido do produto ou montagem sob temperaturas e umidade extremas for aceitável, indique isso claramente na especificação.
    • Indique as tolerâncias sobre o desempenho do produto ou subconjuntos.
    • Estabelecer padrões para suprimentos de terceiros em termos de mão de obra ou padrões de segurança a serem aplicados ao produto ou montagem. Isso pode incluir, por exemplo, exigir que o produto seja certificado pela UL ou CSA.
    • Indicar detalhadamente as especificações técnicas que o produto ou conjunto deve atender, que são específicas desse produto ou conjunto. Por exemplo, um conjunto eletrônico precisa de especificações para velocidade de processamento e interfaces de produtos eletrônicos, enquanto um subconjunto mecânico precisa de especificações para rigidez e capacidade de carga.
    • Indique qual deve ser a vida útil do produto ou conjunto. Se a manutenção programada ou calibração do produto ou conjunto for aceitável, deve ser declarado na especificação. A especificação declara as condições aceitáveis ​​sob as quais a referida manutenção ou calibração do produto ou montagem deve ser realizada e com que frequência a referida manutenção ou calibração deve ser realizada.

    Parte 3 de 3: Finalizando a especificação

    Imagem intitulada Escreva uma especificação técnica Etapa 6
    1. Dê um título à especificação e um dígito de verificação com a capacidade de revisar.
    Imagem intitulada Escreva uma especificação técnica Etapa 7
    2. Indicar a autoridade da fonte da especificação e a autoridade responsável pelas alterações na especificação. Espaço para assinaturas deve ser incluído para essas autoridades.
    Imagem intitulada Escreva uma Especificação Técnica Etapa 8
    3. Leia a especificação criticamente. Finja ser um artista inexperiente ou um artista tentando minimizar os custos ignorando a especificação o máximo possível. Altere a especificação conforme necessário para fornecer todos os requisitos ao operador inexperiente e fechar lacunas na especificação para o operador de bypass.

    Оцените, пожалуйста статью