10 votos

¿Cómo se hace la documentación del hardware?

Estoy preparando unas diapositivas para mi clase sobre cómo debemos documentar el hardware que estamos desarrollando.

Me gustaría hacer una lista de los documentos que deberíamos hacer al construir un hardware. Me inspiré en la documentación de software UML, que trae un montón de tipos de documentos para casi todas las situaciones.

Según mi experiencia e investigación, muchos proyectos sólo tienen los esquemas, el diseño y la lista de materiales. Creo que también deberíamos añadir información sobre el motivo (requisitos) que nos lleva a elegir un microcontrolador y no otro. También hay información sobre el diseño que simplemente no escribimos, como la posición de componentes especiales que no deben cambiarse.

Dicho esto:

  • ¿Cómo debemos documentar nuestro hardware?
  • ¿Cuáles son los documentos importantes que querrías tener si necesitas hacer algunas mejoras/alteraciones en el hardware de otra persona que nunca has visto?
  • ¿Cómo organizar esta información de forma clara?

3voto

Julien Puntos 627

Estoy totalmente de acuerdo con su tercer párrafo. Aparte de las cosas obvias como los esquemas, las listas de materiales, etc., hay cosas menos tangibles como, como dices, por qué elegiste un componente en particular e igualmente importante, por qué no lo hizo elegir un componente quizás más obvio.

Puede que esté mostrando mi edad, pero todavía me gusta usar un libro de registro de tapa dura para registrar mis procesos de pensamiento y decisiones de diseño, incluso las equivocadas. Si en el futuro alguien intenta sustituir un componente por otro más "adecuado" o mover una pista de la placa de circuito impreso, mis notas pueden decirle que ya he pasado por eso y me he quemado los dedos (¡quizá literalmente!).

Siempre numero las páginas y dejo algunas páginas al principio como índice. También puedes documentar cosas como los cálculos de la disipación de energía, las tolerancias, los tiempos, etc. (esta costumbre viene de mis días en la industria aeroespacial, donde era obligatorio llevar un libro de registro). Por supuesto, siempre puedes poner esta información en un documento de WP, pero yo me quedo con el papel.

Las descripciones de los circuitos también pueden ser apropiadas cuando se trata de circuitos inusuales (especialmente analógicos). Yo los trataría como si fueran comentarios de software para documentar cualquier circuito o función de los componentes que no sea evidente. Los esquemas, al igual que el software, deberían ser "autodocumentados" en la medida de lo posible, pero a veces esto no es suficiente.

Una alternativa más actual, sobre todo en un entorno educativo, podría ser tener una página web del proyecto. Se podría organizar como una colección de blogs para cada disciplina: diseño de hardware, diseño de pcb, software, etc. La naturaleza del blog permitiría a los colaboradores mostrar su flujo de pensamiento y documentar el progreso del proyecto, mientras que otras páginas podrían ser más formales (diagramas de Gantt, resultados de pruebas, etc.). Incluso se podrían añadir actas de reuniones y listas de acciones. Los hipervínculos facilitan las referencias cruzadas y ahora tenemos MathJax, por lo que incluso las ecuaciones de diseño son fáciles de insertar.

2voto

fearphage Puntos 250
  • ¿Cómo debemos documentar nuestro hardware?

  • ¿Cuáles son los documentos importantes que querrías tener si necesitas hacer algunas mejoras/alteraciones en el hardware de otra persona que nunca has visto?

  • ¿Cómo organizar esta información de forma clara?

En nuestra empresa se espera que escribamos documentos de descripción del diseño del hardware. Son bastante sencillos: se explica al principio lo que debe hacer el circuito y luego se entra en detalles en cada sección. Cada El valor de los componentes debe justificarse de alguna manera: si tiene resistencias pullup o en serie "por defecto", deben mencionarse en una nota al principio (por ejemplo, "se utilizan pullups de 10K y condensadores de bypass de 0,1uF a menos que se especifique lo contrario"); de lo contrario, deben explicarse las opciones de los valores de los componentes, por ejemplo, "se utiliza un filtro RC de 4,7K y 0,1uF (tau = 0,47mseg) para limitar los componentes de alta frecuencia" o "se utiliza un multiplexor NLAS4051 para obtener bajas fugas; este nodo del circuito es sensible".

i-Ciencias.com

I-Ciencias es una comunidad de estudiantes y amantes de la ciencia en la que puedes resolver tus problemas y dudas.
Puedes consultar las preguntas de otros usuarios, hacer tus propias preguntas o resolver las de los demás.

Powered by:

X