[Lecture Topic Task] Preparation of a Manual of Code Styles and Conventions

[Janiel777]

Desarrollar un manual de estilos y convenciones de código para el proyecto, serviría como una guía para el equipo de desarrollo.

Se pueden aplicar los principios generales de documentación disciplinada y estructurada mencionados en slide04.pdf para justificar la creación de un manual de convenciones de código. Algunos de estos principios incluyen:

• Claridad y Comprensibilidad: Asegurar que todo el código siga un conjunto estandarizado de reglas mejora su legibilidad, haciendo que el software sea más accesible para todos los desarrolladores actuales y futuros del equipo.

• Consistencia: Al igual que se promueve la consistencia en la documentación de requisitos, un manual de convenciones de código asegura una base coherente para todas las contribuciones al código, lo cual es crucial para el mantenimiento y la escalabilidad del proyecto.

• Comunicación Eficaz: La documentación disciplinada mejora la comunicación indirecta entre los miembros del equipo y otras partes interesadas. Del mismo modo, un manual de convenciones de código facilita una mejor comprensión y colaboración entre los desarrolladores, al proporcionar un lenguaje común de prácticas de codificación.

Estaria usando la siguiente diapositiva como referencia a la hora de hacer este manual:

[Janiel777]

@irsaris Ya hice la documentacion para este issue. Esta en la misma wiki.

https://github.com/uprm-inso4115-2023-2024-s2/semester-project-automated-resume-builder/wiki