Usa oraciones cortas y directas. Evite usar `eso` o `eso`, e indique claramente a qué se refiere el texto. Definir la jerga y las abreviaturas de la industria. Para proporcionar una definición clara de los términos industriales, agregue una sección de definiciones al comienzo de la especificación.
Redacción de una especificación técnica
Contenido
Una especificación técnica es un documento que define un conjunto de normas que debe cumplir un producto o conjunto. Un producto o ensamblaje que no cumple con todos los requisitos específicamente formulados no cumple con la especificación y, a menudo, se lo denomina "fuera de especificación". Las especificaciones se utilizan cuando se emite un contrato de productos o servicios técnicos. La especificación técnica define los requisitos del contrato de venta. Use estos consejos para aprender a escribir una especificación técnica.
Pasos
Parte 1 de 3: Revisión de consideraciones generales
1. Decidir si la especificación debe ser abierta o cerrada.
- Considere una especificación abierta. Una especificación abierta describe el rendimiento requerido sin imponer cómo se debe lograr. Una especificación abierta deja mucha libertad a la entidad que fabrica un producto o realiza un ensamblaje para cumplir con las especificaciones. Por ejemplo, una especificación del tamaño de la memoria de una computadora no especifica el medio exacto que debe usarse para almacenar los datos para cumplir con ese requisito.
- Considere una especificación cerrada. Una especificación cerrada describe no solo el desempeño requerido, sino también las herramientas, tecnologías o partes que deben usarse en el diseño de un producto o ensamblaje, para cumplir con la especificación. Por ejemplo, una especificación de un dispositivo de elevación puede requerir que el producto o el ensamblaje utilice fuerza hidráulica para cumplir con las especificaciones.
2. Establecer los requisitos. Considere todas las especificaciones para determinar si son necesarias para el producto o el ensamblaje.
3. Tener un estilo de escritura claro.
4. Crear una tabla de contenido. Organice el contenido de tal manera que los requisitos generales sobre el producto o el ensamblaje se presenten primero, seguidos de subsecciones más específicas o especificaciones del subensamblaje.
Parte 2 de 3: Crear la especificación
1. Enumerar todos los requisitos que debe cumplir el producto o conjunto. Use la palabra `debe` si desea indicar un requisito. Las condiciones expresadas como `debe` deben cumplirse completa y adecuadamente. Considere lo siguiente y agregue otros factores según lo requiera el producto o ensamblaje para satisfacer las necesidades de la especificación.
- Decidir sobre las dimensiones y/o el peso aceptables del producto.
- Indicar toda la gama de condiciones que debe cumplir el producto o conjunto según la especificación. Si es aceptable un rendimiento reducido del producto o ensamblaje bajo temperaturas y humedad extremas, indíquelo claramente en la especificación.
- Indicar tolerancias sobre el desempeño del producto o subconjuntos.
- Establecer estándares para suministros de terceros en términos de mano de obra o estándares de seguridad que se aplicarán al producto o ensamblaje. Esto puede incluir, por ejemplo, exigir que el producto esté certificado por UL o CSA.
- Indicar detalladamente las especificaciones técnicas que debe cumplir el producto o conjunto, que son específicas de dicho producto o conjunto. Por ejemplo, un ensamblaje electrónico necesita especificaciones de velocidad de procesamiento e interfaces de productos electrónicos, mientras que un subensamblaje mecánico necesita especificaciones de rigidez y capacidad de carga.
- Indicar cuál debe ser la vida útil del producto o conjunto. Si el mantenimiento programado o la calibración del producto o ensamblaje es aceptable, debe indicarse en la especificación. La especificación establece las condiciones aceptables bajo las cuales se debe realizar dicho mantenimiento o calibración del producto o ensamblaje y con qué frecuencia se debe realizar dicho mantenimiento o calibración.
Parte 3 de 3: Finalización de la especificación
1. Asigne a la especificación un título y un dígito de verificación con la capacidad de revisar.
2. Indicar la autoridad de la fuente de la especificación y la autoridad a cargo de los cambios a la especificación. Debe incluirse un espacio para las firmas de estas autoridades.
3. Lea la especificación críticamente. Pretenda ser un artista sin experiencia o un artista que intenta minimizar los costos pasando por alto la especificación tanto como sea posible. Cambie la especificación según sea necesario para proporcionar requisitos completos al operador sin experiencia y cerrar lagunas en la especificación para el operador de derivación.
Artículos sobre el tema. "Redacción de una especificación técnica"
Оцените, пожалуйста статью
Similar
Popular