¿Cómo hacer la documentación de hardware?

10

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

Me gustaría enumerar los documentos que deberíamos hacer al construir algún hardware. Me inspiré en la documentación del software UML, que trae muchos tipos de documentos para casi todas las situaciones.

Según mi experiencia e investigación, muchos proyectos solo tienen los esquemas, el diseño y la lista de materiales. Creo que también debemos agregar información sobre el motivo (requisitos) que nos lleva a elegir un microcontrolador y no el otro. También hay información sobre el diseño que simplemente no escribimos, como posición de componente especial que no se debe cambiar.

Dicho esto:

  • ¿Cómo debemos documentar nuestro hardware?
  • ¿Cuáles son los documentos importantes que desea tener si necesita realizar algunas mejoras o modificaciones en el hardware de otra persona que nunca ha visto?
  • ¿Cómo organizar esta información de forma clara?
pregunta RMAAlmeida

2 respuestas

3

Estoy totalmente de acuerdo con tu tercer párrafo. Aparte de las cosas obvias como esquemas, listas de materiales, etc., hay cosas menos tangibles como, como usted dice, por qué eligió un componente en particular y tan importante, por qué no eligió una opción más obvia componente.

Es posible que esté mostrando mi edad aquí, pero todavía me gusta usar un libro de registro de tapa dura para registrar mis procesos de pensamiento & Decisiones de diseño, incluso las incorrectas. Si alguien en el futuro intenta reemplazar un componente por uno más "adecuado" o mueve una pista en la PCB, mis notas podrían decirle que ya estuve allí y me quemé los dedos (¡quizás literalmente!).

Siempre enumero las páginas y permito algunas páginas en el frente como una tabla de contenido. También puede documentar cosas como cálculos de disipación de potencia, tolerancias, tiempos, etc. (este hábito proviene de mis días en la industria aeroespacial donde era obligatorio mantener un libro de registro). Por supuesto, siempre puede poner esta información en un documento WP, ¡pero me quedo con el papel!

Las descripciones de los circuitos también pueden ser apropiadas cuando se trata de circuitos inusuales (especialmente analógicos). Me gustaría tratar estos comentarios de software como para documentar cualquier circuito o función de componentes no obvios. Los esquemas, como el software, deben ser "auto-documentados" en la medida de lo posible, pero a veces esto no es suficiente.

Una alternativa más actualizada, especialmente en un entorno educativo, podría ser tener un sitio web del proyecto. Esto podría organizarse 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 pensamiento y documentar el progreso continuo del proyecto, mientras que otras páginas podrían ser más formales (progreso). Diagramas de Gantt, resultados de pruebas, etc.). Incluso podría agregar 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.

    
respondido por el MikeJ-UK
2
  
  • ¿Cómo debemos documentar nuestro hardware?

  •   
  • ¿Cuáles son los documentos importantes que desea tener si necesita realizar algunas mejoras o modificaciones en el hardware de otra persona que nunca ha visto?

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

  •   

En nuestra empresa se espera que escribamos documentos de descripción de diseño de hardware. Estos son bastante sencillos: usted explica al principio lo que se supone que debe hacer el circuito y luego detalla cada sección. Se supone que cada valor de componente debe estar justificado de alguna manera: si tiene resistencias en serie o pullup "predeterminadas", deben mencionarse en una nota al principio (por ejemplo, "pullups de 10K y condensadores de bypass de 0.1uF se utilizan a menos que se especifique lo contrario "), de lo contrario, las opciones para los valores de los componentes deben explicarse. p.ej. El "filtro 4.7K y 0.1uF RC (tau = 0.47 ms) se usa para limitar los componentes de alta frecuencia" o el "multiplexor NLAS4051 usado para fugas bajas: este nodo de circuito es sensible".

    
respondido por el Jason S

Lea otras preguntas en las etiquetas