O documento de especificação técnica é um documento que contém as regras e requisitos que devem ser atendidos por um produto ou processo de produção. Produtos ou processos de produção que não atendem aos requisitos e regras listados no documento não atendem às especificações e são geralmente chamados de fora das especificações. As especificações técnicas são usadas na emissão de contratos de produção ou serviços técnicos, para determinar as regras de cumprimento do contrato.
Use as dicas a seguir para escrever um documento de especificações técnicas.
Etapa
Método 1 de 3: Tomando Considerações Gerais
Etapa 1. Decida se deseja escrever uma especificação aberta ou fechada
- Considere escrever uma especificação aberta. O documento de especificação aberta apenas descreve o desempenho a ser alcançado, sem explicar como alcançá-lo. Assim, os implementadores ficam livres para usar qualquer esforço para atender às especificações. Por exemplo, se você estiver escrevendo uma especificação de memória de computador, não será necessário especificar o tipo específico de memória que deve ser usado.
- Considere escrever uma especificação fechada. Além de descrever o desempenho a ser alcançado, o documento de especificação fechada também descreve o equipamento, a tecnologia e os métodos de montagem que devem ser usados no projeto do produto ou nos processos de produção. Por exemplo, um documento de especificação de montagem de máquina pode exigir que o operador use um motor acionado hidraulicamente.
Etapa 2. Determine os requisitos avaliando as especificações existentes
Etapa 3. Determine seu estilo de escrita
- Use frases curtas e diretas.
- Evite usar pronomes relativos. Declare o que você quer dizer claramente no texto.
- Explique os termos técnicos e abreviações comumente usados na área. Para explicar os termos técnicos, adicione um capítulo de "definições" ao início do documento.
Etapa 4. Crie um índice analítico
Coloque os requisitos gerais do produto ou processo de produção no início do documento, seguidos de seções mais específicas.
Método 2 de 3: Criando especificações
Etapa 1. Anote todas as necessidades que devem ser atendidas pelo produto ou processo de produção
Use a palavra "deve" para descrever uma necessidade. As necessidades descritas pela palavra "deve" devem ser totalmente atendidas pelo implementador. Considere os seguintes fatores para determinar a necessidade e adicione outros fatores conforme necessário:
- Determine o peso e / ou tamanho apropriado do produto.
- Descreva por completo as condições ambientais adequadas para a operação do produto. Se o produto estiver sujeito a degradação de desempenho em condições de umidade ou temperatura extremas, anote isso nas especificações.
- Dê tolerância ao desempenho do produto ou processo de produção.
- Defina padrões de fabricação ou segurança de terceiros que devem ser aplicados ao produto ou processo de produção. Por exemplo, você pode exigir que seu produto seja aprovado na certificação UL ou CSA.
- Descreva as especificações técnicas específicas que o produto ou processo de produção deve atingir. Por exemplo, em uma especificação de processo de produção eletrônica, você pode especificar os requisitos de interface e a velocidade de produção, enquanto para uma especificação de processo de produção mecânica, você pode especificar um padrão de densidade ou capacidade.
- Determine a vida útil do produto ou processo de produção. Se o produto ou processo de produção exigir manutenção periódica, inclua uma descrição detalhada do processo na especificação. Na especificação, você deve listar as condições sob as quais a manutenção é necessária e com que freqüência a manutenção deve ser realizada.
Método 3 de 3: Finalizando a Especificação
Etapa 1. Crie um título e um número de controle para a especificação
Certifique-se também de criar um documento de especificações que possa ser revisado.
Etapa 2. Defina a autoridade que pode emitir e modificar especificações e incluir um campo de assinatura como atestado
Etapa 3. Leia as especificações criticamente
Posicione-se como um implementador inexperiente ou um executor que busca economizar dinheiro contornando as especificações sempre que possível. Depois disso, ajuste as especificações conforme necessário para ajudar os implementadores novatos e para fechar as lacunas da astúcia.
