Establecer un conjunto de lineamientos que permitan unificar criterios en la escritura y estructuración del código, con el propósito de minimizar errores e inconsistencias, y de facilitar su comprensión, mantenimiento y continuidad técnica a lo largo del ciclo de vida del proyecto.

Contexto

El proyecto SIGIC se encuentra en una fase inicial de diseño e implementación, con un equipo técnico que estará conformado por diversos perfiles trabajando en paralelo sobre distintos componentes del sistema. Esta configuración exige establecer desde el principio criterios claros de codificación, incluso antes de que se definan los lenguajes o frameworks a utilizar.

El entorno del proyecto se regirá por el marco ágil Scrum, lo cual implica ciclos de trabajo cortos, tareas distribuidas, revisión continua del código y la posible rotación o incorporación de nuevos integrantes. Sin un estándar común, estos factores pueden derivar en inconsistencias técnicas, acumulación de problemas en el código y dificultades en el mantenimiento del sistema.

Por ello, se plantea un estándar básico de codificación transversal, orientado a establecer reglas generales y buenas prácticas que puedan aplicarse desde el primer sprint, independientemente del lenguaje de programación. 

Definiciones

Término	Definición
SIGIC	Sistema Integral de Gestión de Información Científica
Convención	Acuerdo técnico interno para mantener coherencia en el código.
Guía de estilo	Conjunto formal de reglas de codificación por lenguaje.
Estándar	Documento técnico que define lineamientos del proyecto.
Paradigma	Modelo de programación (orientado a objetos, funcional, etc.).
Identificador	Nombre asignado a una entidad del código (variable, función, clase, etc.).
Responsabilidad única	Convención que asigna una función específica por archivo, clase o módulo.
Docstring	Comentario estructurado que documenta clases, funciones o módulos.
Modularidad	División del código en componentes independientes y reutilizables.

---

A continuación se presenta un compendio de documentos con los estándares básicos de codificación, diseñados para establecer prácticas consistentes y facilitar la colaboración entre desarrolladores. Estos lineamientos fundamentales garantizan la legibilidad, mantenibilidad y escalabilidad del código

• Buenas prácticas
• Comentarios en el código
• Estilo de codificación
• Estructuras del código fuente
• Guías oficiales de estilo
• Nombres

⚠ IMPORTANTE

Estos estándares no solo promueven prácticas óptimas que previenen errores comunes, sino que también establecen un lenguaje común entre desarrolladores, acelerando la incorporación de nuevos miembros al equipo y asegurando la continuidad del proyecto a largo plazo. En entornos profesionales, seguir estos estándares refleja madurez técnica y compromiso con la calidad, elementos que distinguen a las organizaciones de desarrollo más eficientes y respetadas en la industria.