Cómo documentar los cambios de protocolo en el firmware

Navega tus respuestas
3

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 compatibles con la versión inversa en el nuevo documento de protocolo, o se debe esperar que los otros desarrolladores busquen el protocolo anterior?

Creo que poner la versión de firmware aplicable en el título hace que el número de versión parezca aplicarse a los documentos en sí. Es decir, la lectura cree que el protocolo está en la versión 2 en lugar de en la versión 2. También creo que las notas de la versión deberían ser su propio documento.

    
pregunta petEEy

2 respuestas

2

Deberías abrir el camino a las personas que desean actualizar el firmware también. Para esto

  • las personas deben comprender si sus desarrollos funcionarán en la nueva versión de firmware. Si solo cambia el protocolo eliminando la versión anterior, existe el riesgo de que las aplicaciones existentes no funcionen y algunas personas simplemente volcarán su dispositivo. Este punto no se trata de documentación, sino de su estrategia tecnológica;

  • Votaría por dos documentos: documento conjunto de la funcionalidad de firmware más reciente y notas de la versión que resaltan los cambios y las adiciones. El tamaño y la complejidad de estos documentos dependen de la gravedad de los cambios a la API existente en el nuevo firmware.

Los documentos del curso deben indicar claramente para qué versión están, cuándo se lanzan y por qué. Ambos documentos deben poder buscarse (por ejemplo, buscar en PDF con la combinación de teclas ^ F) para que los usuarios puedan encontrar fácilmente las palabras que tienen en mente.

    
respondido por el Anonymous
1

Recomiendo exponer al menos una forma de que el software de la aplicación interrogue la versión del firmware para un inicio. En cuanto a la correlación de versiones de documentos, soy un fanático de cómo lo hace node-serialpoet. Echa un vistazo a su Github README.

enlace

    
respondido por el vicatcu

Lea otras preguntas en las etiquetas

motor funcionando sin supervisión ¿Qué esquema de control usan los ESC para los planos RC?