Documentación

Hay que tener en cuenta que somos parte de un proceso, un proceso que empieza desde la idea de resolver un problema, se crea una herramienta y se le da al usuario.

Es súper importante documentar cada elemento del sistema para que el siguiente en la construcción de esta gran fabrica de elementos le pueda ser más fácil y eficiente la construcción. También te permite anticiparte a los momentos que puede tener el que se dedique a conectar este componente y brindarle las herramientas necesarias es nuestro trabajo.

Algunos puntos importantes que tienes que definir en tu documentación dentro del sistema:

Titulo

El nombre del componente que viene desde el diseño del componente

Descripción

La descripción de por qué estamos haciendo este componente y que resuelve

Implementación

Descripción sobre cómo puedes implementar este componente en tu proyecto

Estados

Estados que tiene con los modificadores o utilidades y si pudiera no funcionar en otros contextos o reglas que no se hayan definido.

Bitacora

Donde defines que cambios a tenido el componente durante la vida del sistema