¿Existe alguna convención para documentar un esquema con notas?

Question

Quiero añadir una explicación de por qué he hecho algo de cierta manera (sobre todo para mi futuro yo) en mi esquema. Ayer al revisar un circuito del año pasado, me pregunté "¿por qué demonios hice eso?". Y después de cambiar el diseño a lo que yo pensaba que debía ser (que no funcionó), el recuerdo de mi decisión original volvió a inundarme, y tuve que revertir el diseño.

Me gustaría empezar a añadir notas y comentarios a mi esquema, pero quiero hacerlo de una forma convencional que tenga sentido para otros ingenieros eléctricos. También me preocupa que añadir comentarios alrededor del esquema pueda hacerlo menos ordenado y, por tanto, menos fácil de leer. Supongo que podría escribir un documento aparte, pero me da la sensación de que sería más fácil de entender si el comentario estuviera junto a los componentes de los que hablo.

¿Existe alguna convención o buena práctica ampliamente conocida al respecto? Creo que no he visto muchas notas o comentarios (si es que he visto alguno) en ninguno de los esquemas que he leído hasta ahora (aunque necesito leer más esquemas). En mi experiencia, las hojas de datos suelen ser una buena fuente de explicaciones.

Answer 1

Añado tres tipos de notas. NOTA DE DISEÑO: o NOTA DE FIRMWARE: o NOTA DE DISEÑO:

FIRMWARE NOTE: es para algo como requerimientos de secuencia para pines IO o documentar estados prohibidos (GPIO G5 y G6 nunca deben estar altos simultáneamente).

Puede que también incluya una tabla IO para indicar claramente cómo deben configurarse los pines IO (en cuanto a funciones alternativas). Por ejemplo GPIOA4 debe ser configurado como ADC1_IN3 o algo así.

En las notas de diseño, suelo incluir las relaciones de división de los divisores de tensión. En el caso de los reguladores, añado una nota de diseño que muestra el cálculo de la tensión de salida y la tensión de realimentación del regulador.

A veces añado una breve explicación de cómo se supone que funciona un circuito o un rápido análisis de tolerancias.

Si tengo un sensor (por ejemplo, un sensor de temperatura) añadiré una nota con la ecuación para convertir la tensión en temperatura.

He aquí un pequeño fragmento que creo que está bien compartir (soy el creador de la imagen):

No creo que haya ninguna convención. Pero sin duda es una buena idea poner notas en el esquema. En el pasado, los ingenieros de FW me han pedido que las incluya y trato de acordarme de poner el tipo de cosas que les gustaría saber.

Para las notas de diseño, el objetivo es evitar que un EE posterior (o yo 6 meses después) tenga que buscar un montón de cosas en las hojas de datos o adivinar las motivaciones.

Para las notas FW el objetivo es ahorrar tiempo al ingeniero FW, especialmente si la funcionalidad de alguna parte del circuito depende de otros pines IO. Si usted tiene que conducir un pin IO alto para habilitar un sensor. Prefiero poner esa nota en el esquema (como en el ejemplo) que tener al ingeniero de FW viniendo a mí más tarde y diciendo "No creo que el sensor de corriente esté funcionando ". Llevo un día entero intentando obtener una lectura y siempre es cero" o lo que sea.

Del mismo modo, si hay un sensor conectado a una entrada ADC quiero poner suficiente información en el esquema para que el ingeniero FW puede escribir el código sin tirar de la hoja de datos para el sensor. Si el sensor es programable o elaborado y complicado, entonces eso sería diferente, supongo. Pero en el caso de sensores sencillos, intentaría explicarlo en el esquema.

Answer 2

Nunca he visto una convención para esto. Para añadir mi granito de arena, sobre el esquema, yo sólo señalaría un archivo "readme.txt" guardado en el mismo directorio del ordenador que el esquema. Ventajas que veo: En el futuro, no todo el mundo podrá abrir/ver tus archivos esquemáticos, y cualquiera podrá alterar o compartir el archivo de texto (de cualquier tamaño creciente) si es necesario.