Me voy a centrar principalmente las siguientes partes de la generación de un proyecto de electrónica:
- Programación del firmware. Aquí se va a utilizar principalmente C
- Esquemas (planos)
- Documentación de fabricación. Además de los gerbers y el BOM de una PCB yo entrego una serie de documentación adicional.
Las herramientas que utilizo para generar la documentación son:
- Doxygen (https://www.doxygen.nl/). Para generar la documentación a partir de comentarios en el código. Es fácil de aprender a usar y, si te quieres meter a fondo, tiene un montón de posibilidades.
- PlantUML (http://www.plantuml.com/). Se integra muy bien con Doxygen y permite hacer un montón de tipos de diagramas UML simplemente describiéndolos en el texto.
- Dia (https://wiki.gnome.org/Apps/Dia). Cuando no pueda o no quiera describir un diagrama con PlantUML los dibujaré con esta aplicación.
- Libre Office (https://es.libreoffice.org/). Algunos documentos tienen que ser escritos a mano así que...
La mayor parte de la documentación se realiza sobre el documento de trabajo (ya sea el código, los esquemas o la PCB) así que además pondré las formas que utiliza para documentar.
También iré añadiendo algunas otras cosas como el control de versiones y organización de los documentos que se generan.
No hay comentarios:
Publicar un comentario