refactor: reorganize documentation by migrating manual files to docx format and adding automation scripts

2026-04-15 11:47:25 -04:00
parent 6f8b723d64
commit d550babd8a
49 changed files with 2000 additions and 324 deletions
@@ -1,66 +0,0 @@
-# Brochure Comercial - Plataforma Studio
-
-## 1) Qué es Studio
-Studio es la plataforma de autoría académica de OpenCCB para diseñar, publicar y administrar cursos de alta fidelidad. Está orientada a instituciones educativas, equipos académicos y docentes que necesitan construir experiencias de aprendizaje interactivas sin fricción técnica.
-
-## 2) Propuesta de valor
- Diseño instruccional en un entorno moderno y visual.
- Creación de lecciones modulares con bloques interactivos.
- Banco de preguntas reutilizable para evaluaciones.
- Gestión de usuarios, cursos y configuraciones institucionales.
- Integración con LMS Experience para consumo de contenidos por estudiantes.
-
-## 3) Capacidades principales
- Gestión de cursos: creación, edición, estructura por módulos y lecciones.
- Constructor de lecciones: bloques de texto, multimedia, quiz, respuestas cortas, ordenamiento, matching, hotspot, audio-response, peer review, role-playing y mermaid.
- Plantillas: plantillas de curso y de pruebas para estandarizar procesos.
- Biblioteca de assets: administración y reutilización de recursos multimedia.
- Banco de preguntas: catálogo de preguntas filtrable por tipo y dificultad.
- Analítica y seguimiento: soporte para revisión de progreso y evaluaciones.
- Branding institucional: logo, favicon y colores de marca.
-
-## 4) Beneficios para la institución
- Reduce tiempos de producción académica.
- Estandariza calidad de contenidos.
- Facilita colaboración entre docentes y equipos de diseño instruccional.
- Mejora la trazabilidad de evaluaciones y resultados.
- Acelera despliegues de nuevos programas y cursos.
-
-## 5) Flujo recomendado de uso
-1. Configurar branding institucional.
-2. Crear curso y definir módulos.
-3. Diseñar lecciones con bloques interactivos.
-4. Configurar evaluaciones y rúbricas.
-5. Publicar y monitorear desempeño.
-
-## 6) Capturas sugeridas (fotos)
-Pantalla de acceso
-
-![Pantalla de acceso](assets/studio/01-login-studio.png)
-
-Vista principal de cursos
-
-![Dashboard de cursos](assets/studio/02-dashboard-cursos.png)
-
-Editor de lección con bloques
-
-![Editor de leccion](assets/studio/03-editor-leccion.png)
-
-Banco de preguntas y filtros
-
-![Banco de preguntas](assets/studio/04-banco-preguntas.png)
-
-Librería de recursos
-
-![Libreria de assets](assets/studio/05-library-assets.png)
-
-Editor de rúbricas
-
-![Rubricas](assets/studio/06-rubricas.png)
-
-Administración de usuarios
-
-![Administracion de usuarios](assets/studio/07-admin-usuarios.png)
-
-## 7) Mensaje comercial breve
-Studio convierte el diseño académico en un proceso más rápido, controlado y escalable. Permite a la institución pasar de la idea al curso publicado con calidad pedagógica y consistencia operacional.
@@ -1,140 +0,0 @@
-# Manual de Usuario - Plataforma Studio
-
-## 1) Objetivo
-Este manual explica cómo usar Studio para crear y administrar cursos, lecciones y evaluaciones.
-
-## 2) Perfil de usuario
- Docentes
- Diseñadores instruccionales
- Administradores académicos
-
-## 3) Acceso a la plataforma
-1. Ir a Studio en el navegador.
-2. Iniciar sesión con credenciales institucionales.
-3. Verificar que el menú principal muestre los módulos habilitados para el rol.
-
-Captura recomendada:
-
-![Login Studio](assets/studio/01-login-studio.png)
-
-## 4) Navegación principal
- Cursos: listado y gestión de cursos.
- Librería: administración de archivos y recursos.
- Banco de preguntas: creación y reutilización de preguntas.
- Plantillas: estandarización de contenidos.
- Configuración: opciones de perfil y parámetros generales.
-
-Captura recomendada:
-
-![Dashboard de cursos](assets/studio/02-dashboard-cursos.png)
-
-## 5) Crear un curso
-1. Entrar a Cursos.
-2. Seleccionar Crear curso.
-3. Definir título y descripción.
-4. Guardar para habilitar el editor completo.
-
-Buenas prácticas:
- Usar nombres claros por nivel/tema.
- Definir objetivos de aprendizaje desde el inicio.
-
-## 6) Editar estructura (módulos y lecciones)
-1. Abrir un curso.
-2. Crear módulos.
-3. Agregar lecciones por módulo.
-4. Ordenar secuencia de aprendizaje.
-
-Captura recomendada:
-
-![Editor de lección](assets/studio/03-editor-leccion.png)
-
-## 7) Constructor de lecciones por bloques
-Tipos recomendados de bloque:
- Description
- Media
- Quiz
- Fill in the blanks
- Matching
- Ordering
- Short answer
- Hotspot
- Audio response
- Peer review
- Role playing
- Mermaid
-
-Flujo:
-1. Agregar bloque.
-2. Configurar contenido e instrucciones.
-3. Guardar cambios.
-4. Previsualizar.
-
-## 8) Banco de preguntas
-1. Entrar a Banco de preguntas.
-2. Crear nueva pregunta.
-3. Definir tipo, dificultad y enunciado.
-4. Guardar y reutilizar en evaluaciones.
-
-Captura recomendada:
-
-![Banco de preguntas](assets/studio/04-banco-preguntas.png)
-
-## 9) Libreria de assets
-1. Subir recursos (imágenes, audio, documentos).
-2. Etiquetar y organizar.
-3. Insertar recursos desde lecciones.
-
-Captura recomendada:
-
-![Librería de assets](assets/studio/05-library-assets.png)
-
-## 10) Rúbricas de evaluación
-1. Crear rúbrica por curso o actividad.
-2. Definir criterios y niveles.
-3. Asignar puntajes por nivel.
-4. Guardar al finalizar la edición.
-
-Captura recomendada:
-
-![Rúbricas](assets/studio/06-rubricas.png)
-
-## 11) Administración de usuarios (rol admin)
-1. Entrar al panel de administración.
-2. Buscar usuario.
-3. Editar rol o estado.
-4. Guardar cambios.
-
-Captura recomendada:
-
-![Administración de usuarios](assets/studio/07-admin-usuarios.png)
-
-## 12) Solución de problemas comunes
- No veo menús esperados:
-  Verificar sesión activa y rol del usuario.
- No se guardan cambios:
-  Confirmar conexión y permisos del curso.
- Recursos no cargan:
-  Revisar formatos permitidos y tamaño del archivo.
-
-## 13) Recomendaciones operativas
- Definir convención de nombres para cursos y módulos.
- Usar plantillas para mantener estándar pedagógico.
- Revisar cada lección en previsualización antes de publicar.
- Mantener el banco de preguntas limpio y etiquetado.
-
-## 14) Checklist de publicacion
- Objetivos definidos.
- Lecciones ordenadas.
- Bloques revisados.
- Evaluaciones probadas.
- Rúbricas listas.
- Recursos multimedia verificados.
-
-## 15) Anexo: inventario de fotos para documentación
- docs/assets/studio/01-login-studio.png
- docs/assets/studio/02-dashboard-cursos.png
- docs/assets/studio/03-editor-leccion.png
- docs/assets/studio/04-banco-preguntas.png
- docs/assets/studio/05-library-assets.png
- docs/assets/studio/06-rubricas.png
- docs/assets/studio/07-admin-usuarios.png
@@ -1,118 +0,0 @@
-# Manual de Usuario - OpenCCB Studio
-*Versión 1.0*
-
-Bienvenido al manual de uso de **OpenCCB Studio**, el entorno de administración integral para gestionar el portal educativo. Aquí aprenderás a ingresar, navegar el panel de administración y gestionar las actividades.
-
---
-
-## 1. Inicio de Sesión
-
-Para acceder a OpenCCB Studio:
-1. Abra su explorador web (se recomienda Google Chrome, Firefox o Edge).
-2. Diríjase a la dirección URL de Studio (por ejemplo: `http://localhost:3000`).
-3. En la pantalla de inicio, ingrese sus credenciales (**Email** y **Contraseña**).
-4. Haga clic en **"Iniciar Sesión"**.
-
-> [!NOTE]
-> *[📸 INSERTA AQUÍ LA CAPTURA DE PANTALLA: Pantalla de Login]*
-> *Nombre sugerido de la imagen para la ruta: `/home/juan/dev/openccb/docs/img/login.png`*
-> ![Pantalla de Login](./img/login.png)
-
---
-
-## 2. Panel de Administrador (Dashboard)
-
-Una vez iniciada la sesión, será redirigido al **Dashboard** o Panel de Control.
-Este panel sirve como el corazón operativo de su plataforma:
-
-*   **Menú Lateral:** En la parte izquierda, encontrará la navegación para acceder a Usuarios, Cursos, Organizaciones, Banco de Preguntas, y el Creador de Ejercicios.
-*   **Resumen General:** La pantalla principal mostrará estadísticas rápidas de uso (total de alumnos inscritos, cursos activos, etc.).
-
-> [!NOTE]
-> *[📸 INSERTA AQUÍ LA CAPTURA DE PANTALLA: Dashboard Principal]*
-> *Nombre sugerido de la imagen: `/home/juan/dev/openccb/docs/img/dashboard.png`*
-> ![Dashboard](./img/dashboard.png)
-
---
-
-## 3. Tipos de Ejercicios y su Creación
-
-OpenCCB Studio permite una gestión altamente detallada del contenido. A continuación se explican los distintos tipos de ejercicios que se pueden construir en la plataforma. 
-
-Para crear cualquiera de ellos, diríjase a **"Banco de Preguntas"** o **"Actividades"** en el menú lateral y presione botón **"Crear Nueva"**.
-
-### 3.1 Opción Múltiple (Multiple Choice)
-Ejercicio estándar donde el estudiante debe elegir una única respuesta correcta (o varias, dependiendo de la configuración) de una lista de alternativas.
-
-**Pasos para crearlo:**
-1. Seleccione "Opción Múltiple" como Tipo de Ejercicio.
-2. Complete el **Enunciado** de la pregunta.
-3. Añada las alternativas haciendo clic en "Agregar Opción".
-4. Marque con el selector ("Correct") la(s) opción(es) que es o son correctas.
-5. Seleccione Guardar.
-
-> [!NOTE]
-> *[📸 INSERTA AQUÍ LA CAPTURA DE PANTALLA: Formulario de creación de "Multiple Choice"]*
-> ![Multiple Choice](./img/ejercicio_multiple_choice.png)
-
-### 3.2 Verdadero / Falso (True/False)
-Este ejercicio evalúa la veracidad de una afirmación o concepto.
-
-**Pasos para crearlo:**
-1. Seleccione "Verdadero o Falso".
-2. Redacte la afirmación de la pregunta.
-3. Marque la alternativa correcta, o bien "Verdadero", o bien "Falso".
-4. Guarde los cambios.
-
-> [!NOTE]
-> *[📸 INSERTA AQUÍ LA CAPTURA DE PANTALLA: Formulario "Verdadero o Falso"]*
-> ![Verdadero Falso](./img/ejercicio_tf.png)
-
-### 3.3 Completar Espacios (Fill in the Blanks)
-Este tipo de ejercicio es ideal para pruebas de lenguaje y gramática. El estudiante debe tippear la palabra exacta.
-
-**Pasos para crearlo:**
-1. Seleccione "Completar Espacio".
-2. Escriba el texto principal e inserte marcadores donde desee que queden los huecos (por ejemplo: `___` o usando el formato del editor).
-3. En el panel de respuestas, declare la palabra correcta para cada marcador.
-4. Puede establecer opciones sensibles a mayúsculas/minúsculas si el módulo de IA lo avala.
-
-> [!NOTE]
-> *[📸 INSERTA AQUÍ LA CAPTURA DE PANTALLA: Configuracion Fill-in-the-blanks]*
-> ![Fill in blanks](./img/ejercicio_fill_blanks.png)
-
-### 3.4 Arrastrar y Soltar (Drag & Drop)
-Ejercicios interactivos donde el usuario asocia conceptos uniendo elementos.
-
-**Pasos para crearlo:**
-1. En configuración, defina los "Contenedores" o zonas destino (Targets).
-2. Defina los "Elementos a arrastrar" (Items).
-3. Establezca las relaciones lógicas indicando qué "Elemento" pertenece a qué "Contenedor" en la sección de respuestas (Mapping).
-
-> [!NOTE]
-> *[📸 INSERTA AQUÍ LA CAPTURA DE PANTALLA: Ejercicio Drag and Drop]*
-> ![Drag and Drop](./img/ejercicio_drag_drop.png)
-
-### 3.5 Respuesta Corta Abierta (Open Ended / AI Graded)
-Con la funcionalidad de Inteligencia Artificial (LLM) de OpenCCB, es posible hacer preguntas de desarrollo donde el alumno escribe su respuesta y un modelo la califica bajo ciertos parámetros de rúbrica.
-
-1. Seleccione "Respuesta Abierta".
-2. Asigne la **Rúbrica de corrección** (ej. "La respuesta debe mencionar las causas de la Revolución Francesa. 0 puntaje si menciona factores incorrectos").
-3. Determine el número máximo de palabras o la extensión requerida.
-4. Elija si desea habilitar Voice-to-Text (Whisper) para responder usando el micrófono.
-
-> [!NOTE]
-> *[📸 INSERTA AQUÍ LA CAPTURA DE PANTALLA: Ejercicio Respuesta Abierta / VoiceToText]*
-> ![Open Ended](./img/ejercicio_open_ended.png)
-
---
-
-## 4. Exportar a PDF desde este Documento
-Como los prerrequisitos se instalaron usando el script `install.sh`, en su entorno puede ubicar la consola y ejecutar este comando dentro del directorio que contiene este archivo (`docs`):
-
-```bash
-# Convertir el manual Markdown a PDF
-pandoc OpenCCB_Manual_Studio.md -o OpenCCB_Manual_Studio.pdf --pdf-engine=xelatex
-```
-
-*(Recuerde colocar las correspondientes imágenes simuladas o tomar las capturas desde su Studio antes en la carpeta `img`)*