295 lines
9.5 KiB
Markdown
295 lines
9.5 KiB
Markdown
# 📚 Kit Completo de Manual de Usuario - OpenCCB Studio
|
|
|
|
## ✅ Archivos Generados
|
|
|
|
La siguiente estructura de archivos ha sido creada para documentar completamente OpenCCB Studio:
|
|
|
|
```
|
|
/home/juan/dev/openccb/
|
|
├── Manual_Usuario_OpenCCB_Studio.docx [43 KB] ⭐ DOCUMENTO PRINCIPAL
|
|
├── README_MANUAL.md Guía de uso y personalización del manual
|
|
├── GUIA_RAPIDA.txt Referencia rápida para usuarios
|
|
├── generate_manual.py Script de generación (ya ejecutado)
|
|
├── add_screenshots_to_manual.py Script para insertar screenshots
|
|
└── Screenshots_TEMPLATE/ [Crear carpeta para screenshots]
|
|
├── dashboard.png Panel principal
|
|
├── test-templates.png Plantillas de prueba
|
|
├── course-templates.png Plantillas de curso
|
|
├── create-course.png Crear curso
|
|
├── manage-lessons.png Gestión de lecciones
|
|
├── ai-features.png Generación con IA
|
|
├── exercises.png Ejercicios y evaluaciones
|
|
├── settings.png Configuración
|
|
├── admin-panel.png Panel de administrador
|
|
└── analytics.png Análisis y reportes
|
|
```
|
|
|
|
## 📖 Contenido del Manual (43 KB - ~40-50 páginas)
|
|
|
|
### ✨ Secciones Incluidas
|
|
|
|
| # | Sección | Páginas | Contenido |
|
|
|---|---------|---------|----------|
|
|
| 1 | Portada | 1 | Título, versión, fecha |
|
|
| 2 | Tabla de Contenidos | 1 | Índice navegable |
|
|
| 3 | Introducción | 2 | Características, descripción general |
|
|
| 4 | Acceso al Sistema | 2 | Login, tipos de usuario, autenticación |
|
|
| 5 | Panel Principal | 2 | Componentes, navegación, estadísticas |
|
|
| 6 | Gestión de Usuarios | 3 | Crear, editar, gestionar usuarios |
|
|
| 7 | Plantillas de Prueba | 3 | Crear, agregar preguntas, tipos |
|
|
| 8 | Plantillas de Curso | 4 | Estructura, módulos, configuración |
|
|
| 9 | **Creación de Cursos FLUJO COMPLETO** | **5** | **Paso a paso: Prueba → Plantilla → Curso** |
|
|
| 10 | Gestión de Lecciones | 3 | Editor, componentes, contenido |
|
|
| 11 | **Uso de IA** | **4** | **Generación de preguntas, mejora de textos, análisis** |
|
|
| 12 | Ejercicios y Evaluaciones | 4 | Tipos, crear, calificar |
|
|
| 13 | Configuración de Organización | 4 | Branding, email, plantillas personalizadas |
|
|
| 14 | Panel de Administrador | 4 | Usuarios, cursos, reportes |
|
|
| 15 | Análisis y Reportes | 3 | Dashboard, métricas, exportación |
|
|
| 16 | Resolución de Problemas | 3 | FAQ, soluciones comunes |
|
|
| 17 | Apéndice | 2 | Atajos, glosario |
|
|
|
|
**Total: 43 KB de contenido profesional**
|
|
|
|
---
|
|
|
|
## 🖼️ Cómo Agregar Screenshots
|
|
|
|
### Opción 1: Manual Rápida (Recomendado para empezar)
|
|
|
|
1. **Organize screenshots:**
|
|
```bash
|
|
mkdir -p ~/Screenshots_OpenCCB
|
|
cd ~/Screenshots_OpenCCB
|
|
```
|
|
|
|
2. **Acceda a la aplicación:**
|
|
- Abra https://studio.norteamericano.com
|
|
- Inicie sesión con suas credenciales
|
|
|
|
3. **Tome screenshots de cada sección:**
|
|
- **Panel Principal**: Menú principal después del login (completo)
|
|
- **Plantillas de Prueba**: Menú → Plantillas de Prueba (lista y crear)
|
|
- **Plantillas de Curso**: Menú → Plantillas de Curso (estructura)
|
|
- **Crear Curso**: Diálogo completo de creación
|
|
- **Lecciones**: Editor con contenido (texto, video, etc)
|
|
- **IA**: Pantalla de "Generar con IA"
|
|
- **Ejercicios**: Crear evaluación y vista de estudiante
|
|
- **Configuración**: Sección de Branding y Email
|
|
- **Admin**: Panel de administración (usuarios, reportes)
|
|
- **Análisis**: Dashboard de instructor
|
|
|
|
4. **En Windows:** `Shift + Windows + S` (captura de pantalla)
|
|
**En Mac:** `Cmd + Shift + 4` (captura de pantalla)
|
|
**En Linux:** `Print Screen` o `Shift + Print Screen`
|
|
|
|
5. **Abra el manual en Word:**
|
|
- Archivo → Abrir → `Manual_Usuario_OpenCCB_Studio.docx`
|
|
- Ubique cada sección
|
|
- Insertar → Imagen → Seleccione screenshot
|
|
- Redimensione a ~6 pulgadas de ancho
|
|
- Agregue título descriptivo
|
|
|
|
### Opción 2: Automatizado (Avanzado)
|
|
|
|
```bash
|
|
# 1. Crear carpeta con screenshots
|
|
mkdir Screenshots
|
|
cp ~/Descargas/screenshot*.png Screenshots/
|
|
|
|
# 2. Ejecutar script de inserción
|
|
python3 add_screenshots_to_manual.py Screenshots \
|
|
Manual_Usuario_OpenCCB_Studio.docx \
|
|
Manual_Completo.docx
|
|
|
|
# 3. Resultado: Manual_Completo.docx con imágenes insertadas
|
|
```
|
|
|
|
---
|
|
|
|
## 📸 Especificaciones de Screenshots
|
|
|
|
### Resolución
|
|
- **Mínimo recomendado**: 1920 x 1080 px
|
|
- **Ideal**: 2560 x 1440 px (para claridad)
|
|
- **Formato**: PNG (mejor para UI) o JPG (mejor compresión)
|
|
|
|
### Contenido
|
|
- ✅ Interfaz clara y legible
|
|
- ✅ Datos de demostración obvios (nombres ficticios)
|
|
- ✅ Oculte datos sensibles (emails reales, contraseñas, etc.)
|
|
- ❌ No incluya información de clientes reales
|
|
- ❌ No muestre errores o mensajes de prueba
|
|
|
|
### Captions (Títulos)
|
|
Cada imagen debe tener una leyenda descriptiva:
|
|
- "Figura 1: Panel Principal mostrando list..."
|
|
- "Figura 2: Creación de plantilla de prueba..."
|
|
- "Figura 3: Generador de preguntas con IA..."
|
|
|
|
---
|
|
|
|
## 🎨 Personalización del Manual
|
|
|
|
### 1. Cambiar Portada
|
|
- Abra el DOCX en Word
|
|
- Cambie "Manual de Usuario" por "Manual OpenCCB Studio - [Organización]"
|
|
- Agregue logo en portada
|
|
- Actualice fecha y versión
|
|
|
|
### 2. Actualizar Contactos
|
|
- Sección 14 (Soporte)
|
|
- Reemplace emails y teléfono
|
|
- Agregue URLs de help center
|
|
|
|
### 3. Ajustar Branding
|
|
- Menú → Diseño → Temas
|
|
- Seleccione colores corporativos
|
|
- Herramientas → Estilos → Personalizar
|
|
|
|
### 4. Agregar Más Secciones
|
|
- Ejemplo: "Integraciones" (LTI, SSO, API)
|
|
- Ejemplo: "Mejores Prácticas" para instructores
|
|
- Derecha clic → Insertar tabla de contenidos para actualizar índice
|
|
|
|
---
|
|
|
|
## 📤 Exportación y Distribución
|
|
|
|
### Formato PDF (Recomendado)
|
|
```
|
|
Archivo → Exportar como PDF
|
|
└─ Ideal para: distribución, impresión, compatibilidad
|
|
```
|
|
|
|
### Formato HTML (Web)
|
|
```bash
|
|
python3 convert_to_html.py Manual_Usuario_OpenCCB_Studio.docx
|
|
# Resultado: manual.html para publicar en website
|
|
```
|
|
|
|
### Publicar en Portal
|
|
- Suba archivo PDF a: `/help/manual.pdf`
|
|
- Agregue enlace en página de Ayuda del sistema
|
|
- Considere crear versión interactiva (iBook, EPub)
|
|
|
|
---
|
|
|
|
## 🔄 Actualización Futura
|
|
|
|
El manual está diseñado para ser actualizado fácilmente:
|
|
|
|
1. **Cambios menores:**
|
|
- Abra .docx en Word
|
|
- Edite contenido directamente
|
|
- Incremente número de versión
|
|
|
|
2. **Nuevas características:**
|
|
- Agregue secciones nuevas
|
|
- Tome screenshots de interfaces nuevas
|
|
- Re-generate tabla de contenidos
|
|
|
|
3. **Control de versiones:**
|
|
```
|
|
Manual_Usuario_OpenCCB_Studio_v1.0.docx (Abril 2026)
|
|
Manual_Usuario_OpenCCB_Studio_v1.1.docx (Mayo 2026)
|
|
Manual_Usuario_OpenCCB_Studio_v2.0.docx (Septiembre 2026)
|
|
```
|
|
|
|
---
|
|
|
|
## 📋 Checklist de Finalización
|
|
|
|
- [ ] Generar screenshots de todas las 10 secciones
|
|
- [ ] Insertar imágenes en documento DOCX
|
|
- [ ] Revisar captions y descripciones
|
|
- [ ] Eliminar datos/información sensible
|
|
- [ ] Personalizar datos de contacto
|
|
- [ ] Agregar logo organizacional
|
|
- [ ] Revisar ortografía y formato
|
|
- [ ] Convertir a PDF
|
|
- [ ] Publicar en portal web
|
|
- [ ] Distribuir a usuarios/instructores
|
|
|
|
---
|
|
|
|
## 🆘 Preguntas Frecuentes Sobre el Manual
|
|
|
|
**P: ¿Cuánto tiempo toma completar el manual?**
|
|
R: ~1-2 horas (30 min screenshots + 30 min inserción + 30 min revisión)
|
|
|
|
**P: ¿Necesito experiencia técnica?**
|
|
R: No, el documento está listo en 95%. Solo agregue screenshots.
|
|
|
|
**P: ¿Puedo traducir a otro idioma?**
|
|
R: Sí, Word tiene función Traducir. O use servicio de traducción profesional.
|
|
|
|
**P: ¿El manual es imprimible?**
|
|
R: Sí, optimizado para impresión a 11" x 8.5" o A4
|
|
|
|
**P: ¿Dónde publico el manual?**
|
|
R: Opciones:
|
|
- Sistema de ayuda del LMS
|
|
- Website de la organización (PDF)
|
|
- Portal de documentación (Confluence, Wiki)
|
|
- Google Drive compartido con usuarios
|
|
|
|
---
|
|
|
|
## 📞 Próximos Pasos
|
|
|
|
1. **Inmediato:**
|
|
```bash
|
|
# Verificar que el archivo existe
|
|
ls -lh Manual_Usuario_OpenCCB_Studio.docx
|
|
```
|
|
|
|
2. **Corto plazo (Hoy):**
|
|
- Abra el manual en Word
|
|
- Personalice portada e información de contacto
|
|
- Comience a tomar screenshots
|
|
|
|
3. **Mediano plazo (Esta semana):**
|
|
- Agregue todos los screenshots
|
|
- Revise y edite contenido
|
|
- Cree versión PDF
|
|
|
|
4. **Largo plazo (Este mes):**
|
|
- Publique en canales de distribución
|
|
- Recopile feedback de usuarios
|
|
- Prepare versión 1.1 con mejoras
|
|
|
|
---
|
|
|
|
## 📊 Estadísticas del Manual
|
|
|
|
- **Tamaño**: 43 KB (DOCX base, sin screenshots)
|
|
- **Páginas**: ~40-50 (sin imágenes)
|
|
- **Palabras**: ~15,000
|
|
- **Secciones**: 14 principales + apéndices
|
|
- **Tablas**: 5+ (referencia, atajos, glosario)
|
|
- **Espacios para screenshots**: 10+ secciones preparadas
|
|
- **Idioma**: Español (completamente localizado)
|
|
- **Formato**: Microsoft Word 2007+ (.docx)
|
|
|
|
---
|
|
|
|
## ✨ Características Destacadas del Manual
|
|
|
|
✅ Flujo completo de creación de cursos (Prueba → Plantilla → Curso)
|
|
✅ Sección dedicada a IA en educación
|
|
✅ Instrucciones paso a paso para todas las características
|
|
✅ FAQ con problemas comunes y soluciones
|
|
✅ Tabla de contenidos navegable
|
|
✅ Glosario de términos técnicos
|
|
✅ Atajos de teclado y tips de productividad
|
|
✅ Estructurado para fácil actualización
|
|
✅ Profesionalmente diseñado con estilos coherentes
|
|
✅ Listo para impresión y distribución digital
|
|
|
|
---
|
|
|
|
**Generado**: 15 de Abril de 2026
|
|
**OpenCCB Studio v1.0**
|
|
**Manual v1.0**
|
|
© 2026 OpenCCB. Todos los derechos reservados.
|