Cómo redactar un documento de requisitos de ingeniería

Un documento de requisitos de ingeniería (ERD) es una declaración que describe el objetivo y el propósito de un nuevo componente. A diferencia de un documento de requisitos del producto (PRD), que les dice a los ingenieros lo que necesitan construir, un ERD especifica por qué se está construyendo una pieza y cómo su diseño alimenta su propósito. Al seguir los requisitos de ingeniería descritos en un ERD, los ingenieros pueden asegurarse de que la pieza que construyan satisfará las necesidades del cliente. El uso de un ERD también ayuda a optimizar la producción de varias maneras:

• Los ERD utilizan una comunicación definida y consistente para promover la colaboración, reducir la falta de comunicación y mantener a todos en sintonía.
• Los ERD ayudan a dividir proyectos grandes en tareas más pequeñas, lo que facilita su delegación o subcontratación.
• Los ERD se pueden comparar con los PRD para garantizar que todas las intenciones de diseño se implementen correctamente y se logren todos los objetivos del producto.

Un ERD bien escrito permite a los ingenieros y fabricantes responder preguntas críticas sobre el diseño y el propósito de la pieza sin tener que ir y venir. Esto da como resultado un proceso de construcción más rápido y eficiente que le ahorra tiempo y dinero. Aquí encontrará todo lo que necesita saber para redactar un documento de requisitos de ingeniería claro y efectivo.

Criterios estándar para un documento de requisitos de ingeniería

Para empezar, todos los documentos de requisitos de ingeniería efectivos tienen los siguientes seis elementos en común:

Claridad

Todos los requisitos de ingeniería deben ser claros, breves e inequívocos para evitar confusiones. Menos es más; a menudo, una descripción de una oración será suficiente.

Necesidad

Para evitar confusiones o contradicciones, solo ponga los requisitos absolutamente esenciales en su ERD. Determine el peor de los casos para cada requisito y, si no hay consecuencias, no es necesario que esté en su ERD.

Coordinación

Los requisitos de ingeniería deben ser correctos en todo el diseño del producto. Un ERD debe describir todos los requisitos, objetivos, condiciones y capacidades del producto. Siempre que sea posible, explique lo que hace el producto de forma numérica para lograr la mayor precisión.

Comprobabilidad

Siempre que escriba un nuevo requisito de ingeniería, debe poder verificar una implementación exitosa. Existen muchos tipos diferentes de métodos de prueba para garantizar la verificabilidad, incluida la inspección, las pruebas de usuario, las pruebas de software y las pruebas de integración del sistema. Elija el método de prueba que tenga más sentido para su proyecto.

Viabilidad

Manténgase dentro de los límites de lo que se puede lograr técnicamente, así como lo que es legal, organizacional y financieramente posible. Sea razonable y honesto, ya que la creación de requisitos no factibles causará complicaciones en el futuro. Si no se puede alcanzar la viabilidad, puede establecer un detalle de diseño como un objetivo en lugar de un requisito.

Trazabilidad

Cualquier ingeniero que observe su ERD debería poder rastrear cada requisito hasta el propósito del producto original. Vincular las implementaciones a los objetivos del producto ayuda a explicar por qué un elemento es importante, de dónde proviene y cómo tiene sentido con el diseño general de la pieza.

Consejos para redactar un buen documento de requisitos de ingeniería

Una vez que se haya asegurado de que se han tenido en cuenta los criterios estándar, puede implementar las mejores prácticas que llevarán su documento de requisitos de ingeniería al siguiente nivel. Aquí hay cinco consejos para escribir un documento de requisitos de ingeniería de primer nivel.

Usar una plantilla de requisitos de ingeniería

Puede ahorrar tiempo y energía al comienzo de un nuevo proyecto utilizando una plantilla de documento de requisitos de ingeniería. Una plantilla de ERD garantiza que su ERD siempre esté correctamente estructurado. Como mínimo, una plantilla de documento de requisitos de ingeniería debe tener una portada, encabezados de sección y otras secciones estandarizadas conocidas como "repeticiones". Use repeticiones para cubrir temas de ERD como el uso de verbos, abreviaturas, palabras clave, estándares de formato y otras pautas necesarias para comprender su ERD.

Evite escribir operaciones e implementaciones

Sus requisitos de ingeniería deben indicar un objetivo, no cómo se logrará el objetivo. Si explica los pasos para completar un propósito en lugar del propósito en sí, en realidad no está escribiendo un ERD, está escribiendo una guía de operaciones e implementación. Si escribe una guía de operaciones e implementaciones por error, un fabricante podría malinterpretar sus intenciones y los objetivos de su proyecto podrían no cumplirse.

Para asegurarse de que sus requisitos sean realmente requisitos, pregúntese por qué este requisito es una parte necesaria de su documento de requisitos de ingeniería. Confíe en que los diseñadores y fabricantes del sistema determinarán cómo se logrará el objetivo y lo harán de la manera más eficiente posible.

Evalúa tu ERD

Esto ayudará a verificar que todos los requisitos de ingeniería cumplan con los objetivos establecidos y las aspiraciones de la empresa. Para una evaluación completa, es mejor armar un equipo diverso. Esto incluye reunir a personas de todas las razas, etnias y géneros para evaluar su documento de requisitos de ingeniería, pero también incluye incorporar una diversidad de roles a la evaluación. Incluya tantos roles como pueda (diseñadores, desarrolladores, probadores, representantes de usuarios finales, aquellos a cargo del mantenimiento y la administración y, por supuesto, el equipo del cliente) para aportar mucha información valiosa a su evaluación de ERD.

Utiliza el lenguaje correcto

Hay algunas reglas de lenguaje que siempre debe seguir al escribir un documento de requisitos de ingeniería. Los tres grandes términos específicos de ERD son deberá, voluntad y debería. "Deberá" representa requisitos, "voluntad" representa hechos y "debería" representa objetivos.

Un término específico de ERD que a menudo se usa incorrectamente es apoyo. En términos de ERD, "apoyo" hace referencia a la capacidad de una estructura para sostener o soportar peso, no que soportará o logrará ciertas capacidades.

En general, manténgase alejado de términos como son, es y fue en los requisitos de ingeniería. Puede usarlos en una sección descriptiva o que conduzca a un requisito, pero evítelos en su propio requisito para promover la especificidad. También debe evitar términos vagos como:

• Pero no limitado a o etc. — Estos términos cubren lo desconocido y no debe haber nada desconocido o impredecible sobre su ERD.
• Y/o — Esto deja demasiadas opciones de interpretación y margen de error porque un contratista tendrá razón en dos escenarios diferentes (si elige Y o si elige O).
• Palabras débiles que no tienen significados cuantitativos. Esto incluye adjetivos como "poderoso" y "eficiente", así como verbos como "mejorar" o "fortalecer". Además, trate de evitar las comparaciones (por ejemplo, rápido o lento, la mayoría o pocos) y otro lenguaje no cuantitativo.

Al escribir ERD, también debe evitar declaraciones negativas y centrarse en la existencia del elemento o la capacidad de un requisito. La única vez que es aceptable usar especificaciones negativas es cuando se enfatiza una situación potencialmente peligrosa. Incluso en estos casos, asegúrese de indicar también el caso de seguridad.

No seas demasiado específico

Aunque hay muchas reglas de lenguaje a seguir al escribir su documento de requisitos de ingeniería, manténgalo simple. La claridad es clave para los ERD, así que solo concéntrese en las metas, los objetivos y las limitaciones necesarios de su requisito. Siempre tenga una razón para poner un requisito:demasiados requisitos confundirán su ERD y confundirán a los lectores. Si cree que sus requisitos se vuelven demasiado largos y complicados, use viñetas para dividir sus elementos.
Tener un documento de requisitos de ingeniería (ERD) bien escrito ayudará a los ingenieros, equipos de productos y otros colaboradores a comprender mejor sus intenciones de diseño. Al conectar claramente el diseño de un componente con sus objetivos específicos y el propósito general de la pieza, un ERD garantiza que un producto se construya de manera que satisfaga las necesidades del cliente.

Lo que es más importante, un gran ERD promueve la colaboración, la comunicación y la claridad a lo largo del proceso de diseño y fabricación. Esto asegurará que todas y cada una de las partes sean completamente funcionales y completarán los objetivos deseados. Además de garantizar la consistencia de parte a parte, un ERD también promueve ciclos de producción más rápidos y costos más bajos.

Ya sea que esté escribiendo su primer documento de requisitos de ingeniería o tenga mucha práctica, Fast Radius está aquí para ayudarlo en cada etapa del proceso de desarrollo y producción. Nuestro equipo de diseñadores, ingenieros y fabricantes expertos está aquí para garantizar que su pieza logre todos sus objetivos. Contáctenos hoy.

Para obtener más recursos sobre el desarrollo de productos, visite el centro de aprendizaje de Fast Radius.

¿Listo para fabricar tus piezas con Fast Radius?

Inicia tu cotización