---
name: 📖 Mejora de Documentación
about: Reportar problemas o sugerir mejoras en la documentación
title: '[DOCS] '
labels: ['documentation', 'needs-review']
assignees: ''
---
## 📖 Tipo de Mejora de Documentación
- [ ] Error en documentación existente
- [ ] Información faltante
- [ ] Documentación obsoleta
- [ ] Clarificación necesaria
- [ ] Nueva documentación requerida
- [ ] Mejora en formato/estructura
- [ ] Traducción o correcciones de idioma
- [ ] Ejemplos de código faltantes
## 📍 Ubicación
**¿Dónde está la documentación afectada?**
- [ ] README principal
- [ ] Documentación de módulo específico
- [ ] Comentarios en código
- [ ] Guía de contribución
- [ ] Código de conducta
- [ ] Templates de issues
- [ ] Documentación de APIs
- [ ] Guías de setup/instalación
**Archivo(s) específico(s):**
- Ruta del archivo:
- Sección específica:
- Líneas (si aplica):
## 🔍 Problema Identificado
### Descripción del Problema
Describe claramente qué está mal o qué falta en la documentación actual.
### Impacto en el Usuario
- [ ] Bloquea el progreso en el bootcamp
- [ ] Causa confusión sobre conceptos
- [ ] Dificulta la configuración inicial
- [ ] Impide contribuir al proyecto
- [ ] Genera malentendidos técnicos
- [ ] Afecta la experiencia de aprendizaje
### Evidencia del Problema
- Capturas de pantalla:
- Citas del texto problemático:
- Reportes de otros usuarios:
## 💡 Solución Propuesta
### Contenido Sugerido
```markdown
Proporciona el texto/contenido mejorado que sugieres
```
### Estructura Mejorada
Si propones cambios estructurales, describe la nueva organización.
### Ejemplos Adicionales
Si se necesitan ejemplos de código, proporciona algunos:
```typescript
// Ejemplo de código que debería incluirse
```
## 🎯 Audiencia Objetivo
**¿Para quién es esta documentación?**
- [ ] Estudiantes principiantes (Módulos 1-2)
- [ ] Estudiantes intermedios (Módulos 3-4)
- [ ] Estudiantes avanzados (Módulos 5-7)
- [ ] Instructores y mentores
- [ ] Contribuidores al proyecto
- [ ] Desarrolladores experimentados
- [ ] Usuarios de primera vez
**Nivel de detalle técnico:**
- [ ] Conceptual/introductorio
- [ ] Práctico/tutorial
- [ ] Referencia técnica
- [ ] Guía de mejores prácticas
## 📚 Contexto Educativo
### Objetivos de Aprendizaje
¿Qué debe entender el lector después de consultar esta documentación?
### Prerrequisitos
¿Qué conocimientos previos asume la documentación?
### Conexión con el Bootcamp
¿Cómo se relaciona con los módulos y ejercicios del bootcamp?
## 🔧 Aspectos Técnicos
### Tecnologías Involucradas
- [ ] TypeScript/Node.js
- [ ] Python/FastAPI
- [ ] Docker/Containerización
- [ ] Bases de datos
- [ ] Testing
- [ ] CI/CD
- [ ] Deployment
### Plataformas Afectadas
- [ ] GitHub (README, wikis)
- [ ] VS Code (comentarios, configuración)
- [ ] Documentación online
- [ ] Archivos de configuración
## 📝 Estándares de Calidad
### Checklist de Calidad para Documentación
- [ ] Información precisa y actualizada
- [ ] Lenguaje claro y accesible
- [ ] Ejemplos funcionales y relevantes
- [ ] Estructura lógica y navegable
- [ ] Enlaces verificados y útiles
- [ ] Formato consistente
- [ ] Traducción correcta (español)
### Estilo y Formato
- [ ] Sigue las convenciones del proyecto
- [ ] Usa markdown apropiadamente
- [ ] Incluye código sintácticamente correcto
- [ ] Mantiene consistencia con otra documentación
## 🌐 Consideraciones de Localización
**Idioma y cultura:**
- [ ] Correcciones de español
- [ ] Términos técnicos apropiados
- [ ] Contexto cultural relevante
- [ ] Ejemplos localizados
**Accesibilidad:**
- [ ] Alt text para imágenes
- [ ] Estructura semántica apropiada
- [ ] Contraste y legibilidad
- [ ] Navegación clara
## 📊 Métricas de Éxito
**¿Cómo sabremos que la mejora fue exitosa?**
- [ ] Menos preguntas sobre el tema en issues
- [ ] Feedback positivo de usuarios
- [ ] Mejor flujo de onboarding
- [ ] Menos errores de configuración
- [ ] Mayor participación en ejercicios
## 🔗 Referencias y Recursos
### Documentación Relacionada
- Enlaces a documentación oficial de MCP:
- Recursos de las tecnologías usadas:
- Ejemplos en otros proyectos:
### Estándares de Documentación
- Guías de estilo seguidas:
- Templates utilizados:
- Herramientas de documentación:
## ✅ Checklist de Implementación
**Para el implementador:**
- [ ] He revisado la documentación actual completa
- [ ] He verificado que la información nueva es precisa
- [ ] He incluido ejemplos funcionales
- [ ] He mantenido consistencia con el estilo existente
- [ ] He verificado enlaces y referencias
- [ ] He considerado la audiencia objetivo
- [ ] He revisado ortografía y gramática
## 🤝 Contribución
**¿Cómo puedes ayudar con esta mejora?**
- [ ] Puedo escribir el contenido completo
- [ ] Puedo revisar y editar
- [ ] Puedo proporcionar ejemplos técnicos
- [ ] Puedo verificar precisión técnica
- [ ] Puedo hacer testing de usuario
- [ ] Solo estoy reportando el problema
**Experiencia relevante:**
- Experiencia técnica con las tecnologías:
- Experiencia escribiendo documentación:
- Conocimiento del bootcamp MCP:
---
**Tip**: La mejor documentación es aquella que anticipa las preguntas del usuario y las responde de manera clara, concisa y con ejemplos prácticos. 📚
