DeCómo empaquetar su paquete LaTeXtutorial:
"Las partes importantes de un paquete son el código, la documentación del código y la documentación del usuario".
¿Cuál es la diferencia entre documentación del código y documentación del usuario?
Respuesta1
Bueno, a pesar de que jjdb dio en el clavo con:
documentación de usuario = guía de usuario, documentación del código = guía de programadores
Intentaré ser un poco más poético:
La guía del usuario, como su nombre lo indica, está destinada a ser utilizada por el usuario, es decir, el tipo que se sienta detrás de la computadora y usa su código para hacer lo que necesita hacer.
El código de documentación es parte de las buenas prácticas que sigue un programador para llevar un registro de lo que está haciendo, dejar mensajes claros a cualquiera que quiera tocar el código y mantener su mente sana (especialmente cuando regresa de largos periodos de trabajo). sin interacción con el código).
Básicamente, la documentación de usuario debe ser lo más explicativa posible, ya que no se sabe cuál es el nivel de comprensión del paquete por parte de la persona que la está leyendo (recordemos que si esta es la primera versión, lo más probable es que nadie la haya visto nunca). antes), mientras que la documentación del código debe estar orientada a demostrar qué está haciendo su código y dónde lo está haciendo, de modo que cualquier modificación se pueda realizar lo más fácilmente posible.