DESCARGAR

A la hora de realizar un proyecto software, además de la memoria y el manual de usuario es necesario realizar un manual técnico o manual de código.

El manual de código es necesario y muy útil para poder tener un documento específico técnico que ayude a otros ingenieros o programadores a entender cómo funciona, interactúa el software. Además de los módulos de los que consta y dependencias. Este manual ayudará a la corrección de errores y realizar futuras mejoras si se hace bien de una forma clara y precisa.

Si bien no hay un estándar general para realizar un manual de código, si que hay bastantes recomendaciones específicas para cada tipo de programa y unos consejos básicos, pero muy importantes, a la hora de realizar el código del software para que sea autodocumentado y claro.

Para la asignatura de Proyectos de I.T. Informática de Sistemas hemos realizado una presentación con los puntos más importantes, a nuestro entendimiento, de cómo hay que realizar el manual de código y qué herramientas existen para ello. Sin más podéis descargar el PDF junto a un ejemplo de Doxygen y un how-to de OpenOffice.org para crear un estilo de código.