📘 Bienvenidos
Esta documentación ha sido diseñada pensando en el uso de la suite de herramientas desarrolladas por CentroGeo. Su objetivo es definir buenas prácticas que aseguren la calidad del código fuente desde las primeras etapas del proyecto.
📌 Contexto
El proyecto SIGIC se encuentra actualmente en su fase inicial de diseño e implementación. Dada la naturaleza multidisciplinaria del equipo técnico (compuesto por perfiles diversos que trabajarán en paralelo sobre distintos componentes del sistema), resulta necesario definir un marco de referencia común que oriente las prácticas de trabajo de manera coherente y estructurada.
En este sentido, y considerando que el proyecto operará bajo el marco ágil Scrum, caracterizado por iteraciones cortas, tareas distribuidas, incorporación flexible de nuevos integrantes y una dinámica colaborativa constante, resulta necesario establecer directrices generales que trasciendan aspectos técnicos específicos. Estas directrices permitirán asegurar la consistencia metodológica y técnica a lo largo del ciclo de vida del proyecto.
Por ello, en el presente documento se definen una serie de guías estructuradas para el desarrollo, con base en estándares internacionales reconocidos,adaptadas al contexto y necesidades de este proyecto.
🎯 Objetivo
Establecer un conjunto de lineamientos que unifiquen criterios en la escritura y estructuración del código, con el propósito de:
- Minimizar errores e inconsistencias.
- Facilitar la comprensión del código.
- Asegurar la mantenibilidad y continuidad técnica a lo largo del proyecto.
🛠 ️ Base Técnica del Estándar
Dentro del presente compendio documental encontrarás:
🎯 Propósito
El propósito de esta documentación es proporcionar una base estructurada para el desarrollo, que permita garantizar:
- La calidad del producto desde el inicio.
- La alineación técnica entre los diferentes actores del equipo.
- La aplicación de buenas prácticas.
✅ Buenas Prácticas
(Esta sección puede ampliarse con subsecciones específicas según roles o tecnologías)
📚 Referencias
- Google. (2022). Google Style Guides. Recuperado de: https://github.com/google/styleguide
- INEGI. (2021). Guía metodológica para la documentación de metadatos estadísticos y geográficos.
- ISO 10013:2021. Quality management systems — Guidance for documented information.