Preguntas con etiqueta 'documentation'

3
respuestas

¿Cómo documenta bodges?

Después de hacer los PCB, decidimos algunos cuerpos y los implementamos en los PCB. ¿Cuál es la forma estándar de documentar eso en los esquemas? Por ahora, dibujé a mano con el mouse, pinte el estilo, en los esquemas de los archivos PDF, par...
2
respuestas

Mejores prácticas para hacer esquemas de cable

Me gustaría hacer esquemas de cable para la fabricación que incluyan: longitudes de cable conectores alfileres longitud del conducto longitud del tubo termocontraíble y tiene una lista de materiales para eso generado automáticamen...
5
respuestas

¿Mejores prácticas para documentar puertos / periféricos?

Recientemente me interesé por el desarrollo integrado y me pregunto cómo la mayoría de las personas documentan sus proyectos. Por ejemplo:    Cada pin en PORTE está conectado a un LED y tiene un alias como LEDPORT .    Los méto...
2
respuestas

Aprendiendo a leer hojas de datos

Como ingeniero electrónico, entiendo que uno pasa mucho tiempo entendiendo las hojas de datos. Descubrí que la habilidad de leer hojas de datos es mucho más difícil de lo que esperaba. En todo caso, una hoja de datos no es "autoexplicativa": se...
1
respuesta

Generador de documentación para proyectos C incrustados

Estoy buscando el equivalente de lo que Javadoc es para Java y, a partir de ahí, una forma de estandarizar la documentación del código. . Es doxygen más común en este contexto. ¿Hay opciones integradas, dependientes de IDE? Estoy interesado...
4
respuestas

convenciones de nomenclatura manual de TI?

¿Alguien puede arrojar algo de luz sobre las convenciones de nombres utilizadas por los manuales / guías / documentos de Texas Instruments? Por ejemplo slaa490, slau337. ¿Hay algún patrón oculto? De todos modos, solo mirando el nombre del archiv...
1
respuesta

¿Existe una forma correcta de documentar el cumplimiento de RoHS?

Trabajo para una pequeña empresa de ingeniería eléctrica. Nuestros productos no son actualmente RoHS, pero estamos planeando cambiarlos. Lo mejor que puedo decir, es una cuestión de garantizar que nuestros componentes individuales sean RoHS y qu...
1
respuesta

Documentación para AVR Atmel Studio

Soy nuevo en la programación de AVR y he probado un par de pruebas en lenguaje ensamblador y tuve éxito. Sin embargo, me gustaría probar la programación en C con Atmel Studio. ¿Podría alguien decirme dónde puedo encontrar la documentación...
2
respuestas

Cómo documentar los cambios de protocolo en el firmware

He actualizado el firmware de mi dispositivo para aceptar nuevos comandos. ¿Cómo puedo aclarar a otros desarrolladores que el nuevo documento de protocolo es específico para esta versión reciente? ¿Debo dejar claro qué comandos son compatible...
1
respuesta

¿Cómo se deben comentar los entites y las arquitecturas en VHDL?

¿Cómo deben comentarse una entidad y una arquitectura en VHDL para que se utilicen mejor con Doxygen? Estoy tratando de usar Doxygen para generar documentación útil para mi VHDL, pero no estoy seguro de cuál es la mejor manera de comentar qué...