- Configure workspace Git repository with comprehensive .gitignore - Add Odoo as submodule for ERP reference code - Include documentation: SETUP.md, GIT-STRUCTURE.md - Add gitignore templates for projects (backend, frontend, database) - Structure supports independent repos per project/subproject level Workspace includes: - core/ - Reusable patterns, modules, orchestration system - projects/ - Active projects (erp-suite, gamilit, trading-platform, etc.) - knowledge-base/ - Reference code and patterns (includes Odoo submodule) - devtools/ - Development tools and templates - customers/ - Client implementations template 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
150 lines
3.0 KiB
Markdown
150 lines
3.0 KiB
Markdown
# _MAP: docs/00-overview/
|
|
|
|
**Última actualización:** 2025-11-07
|
|
**Estado:** 🟢 Completo
|
|
**Versión:** 2.0 (RFC-0001)
|
|
**Propósito:** Documentación de alto nivel para onboarding rápido
|
|
|
|
---
|
|
|
|
## 📋 Propósito de esta Carpeta
|
|
|
|
Esta carpeta contiene **documentación de alto nivel** para entender rápidamente el proyecto GAMILIT sin entrar en detalles técnicos. Es el punto de entrada para nuevos miembros del equipo.
|
|
|
|
**Audiencia:**
|
|
- Nuevos desarrolladores (onboarding)
|
|
- Stakeholders (visión del proyecto)
|
|
- Product Owners (contexto general)
|
|
- Cualquier persona que necesite entender GAMILIT en <30 minutos
|
|
|
|
---
|
|
|
|
## 📁 Estructura de Contenido
|
|
|
|
### Archivos Principales
|
|
|
|
| Archivo | Propósito | Tamaño | Owner | Estado |
|
|
|---------|-----------|--------|-------|--------|
|
|
| **VISION.md** | Visión y misión del producto | 12 KB | @product-owner | ✅ Completo |
|
|
| **ONBOARDING.md** | Guía de setup inicial (2-3 horas) | 18 KB | @tech-lead | ✅ Completo |
|
|
| **README.md** | Índice de la carpeta | 9 KB | @tech-lead | ✅ Completo |
|
|
|
|
**Total archivos:** 3
|
|
|
|
---
|
|
|
|
## 🗂️ Detalle de Archivos
|
|
|
|
### VISION.md
|
|
|
|
**Descripción:** Visión, misión y objetivos estratégicos del proyecto
|
|
|
|
**Contenido:**
|
|
- Visión del producto
|
|
- Misión
|
|
- Objetivos estratégicos
|
|
- Propuesta de valor única
|
|
- Contexto educativo guatemalteco
|
|
|
|
**Audiencia:** Stakeholders, nuevos team members
|
|
|
|
**Estado:** ✅ Completo
|
|
|
|
---
|
|
|
|
### ONBOARDING.md
|
|
|
|
**Descripción:** Guía completa de onboarding para nuevos desarrolladores
|
|
|
|
**Contenido:**
|
|
- Setup del entorno local (2-3 horas)
|
|
- Instalación de dependencias
|
|
- Configuración de database
|
|
- Primeros pasos
|
|
- Arquitectura de alto nivel
|
|
- Recursos adicionales
|
|
|
|
**Audiencia:** Nuevos desarrolladores
|
|
|
|
**Tiempo estimado:** 2-3 horas
|
|
|
|
**Estado:** ✅ Completo
|
|
|
|
---
|
|
|
|
### README.md
|
|
|
|
**Descripción:** Índice de la carpeta 00-overview/
|
|
|
|
**Estado:** ✅ Completo
|
|
|
|
---
|
|
|
|
## 🔗 Interdependencias
|
|
|
|
### Esta Carpeta Alimenta A:
|
|
|
|
- **Nuevos desarrolladores** - Onboarding rápido
|
|
- **Stakeholders** - Comprensión del proyecto
|
|
- **Documentación técnica** - Contexto de alto nivel
|
|
|
|
### Esta Carpeta Consume De:
|
|
|
|
- **Product Owner** - Visión del producto
|
|
- **Tech Lead** - Arquitectura de alto nivel
|
|
|
|
---
|
|
|
|
## 📊 Métricas
|
|
|
|
| Métrica | Valor |
|
|
|---------|-------|
|
|
| **Total archivos** | 3 |
|
|
| **Completitud** | 100% |
|
|
| **Útil para onboarding** | ✅ Sí |
|
|
|
|
---
|
|
|
|
## 🚨 Issues Conocidos
|
|
|
|
Ninguno - Carpeta completa
|
|
|
|
---
|
|
|
|
## 📐 Estándares Aplicables
|
|
|
|
### Contenido de Alto Nivel
|
|
|
|
- ✅ Sin detalles técnicos de implementación
|
|
- ✅ Lenguaje accesible para no-técnicos
|
|
- ✅ Enfocado en "qué" y "por qué", no "cómo"
|
|
|
|
---
|
|
|
|
## 🔍 Validación (Go/No-Go)
|
|
|
|
- [x] VISION.md completo ✅
|
|
- [x] ONBOARDING.md completo ✅
|
|
- [x] README.md completo ✅
|
|
- [x] _MAP.md creado (este archivo) ✅
|
|
|
|
**Decisión:** 🟢 **GO** - Carpeta completa
|
|
|
|
---
|
|
|
|
## 📞 Contacto
|
|
|
|
**Owner:** @tech-lead, @product-owner
|
|
|
|
---
|
|
|
|
## 🎯 Próximos Pasos
|
|
|
|
1. ✅ Carpeta completa
|
|
2. ⬜ Mantener actualizado con cambios del proyecto
|
|
|
|
---
|
|
|
|
**Generado:** 2025-11-07
|
|
**Versión:** 1.0.0
|