En esta página, se incluyen los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Kolibri
- Redactor técnico:
- Daniela V
- Nombre del proyecto:
- Flujo de trabajo de contenido de Kolibri
- Duración del proyecto:
- Larga duración (5 meses)
Project description
La siguiente propuesta se creó a partir de una investigación y conversaciones con los mentores de Kolibri. La conversación con los mentores me ayudó a desarrollar las personas de los usuarios que analizo a continuación. Además, mis conversaciones me ayudaron a idear un repositorio o una página de destino de instructivos para que los usuarios puedan elegir el instructivo que quieran ver según sus necesidades.
Descripción general
Esta propuesta presenta una solución para guiar los diversos recorridos del usuario que una persona puede realizar para importar contenido de su computadora a Kolibri Studio y, luego, de Kolibri Studio a Kolibri. Propongo crear un repositorio central de instructivos. El usuario accederá a estos instructivos a través de una página de destino. La página de destino proporcionará una tabla con vínculos a cada instructivo de flujo de trabajo y también indicará el tipo de usuario que el instructivo podría beneficiar. De esta manera, los instructivos se personalizarán más según las necesidades y habilidades del usuario. Varias lecciones demuestran un flujo de trabajo (por ejemplo, INSTALL-IMPORT). Cada lección contiene un video. Los videos muestran una pequeña parte del flujo de trabajo y demuestran conceptos individuales sobre cómo estos flujos de trabajo conectan las aplicaciones de Kolibri.
Objetivos principales
Crea una página de destino de instructivo que ayude a los usuarios a decidir qué flujo de trabajo se adapta mejor a sus necesidades. Esta página de destino se alojará en la plataforma de Read the Docs.
Crea lecciones individuales para los componentes de cada flujo de trabajo y complementa las lecciones difíciles con ejercicios.
Crea videos interactivos para cada flujo de trabajo.
Herramientas de proyecto
El trabajo se realizará con software de transmisión de pantalla. Tengo experiencia con Camtasia, pero también trabajé con software y software gratuito menos costoso. El video de ejemplo que se vincula aquí (https://youtu.be/DkMP_VdGslU) se creó con Flashback de Blueberry Software, para el que tengo una licencia. Crearé subtítulos con YouTube. Las páginas de instructivos se alojarán en el sitio de Read the Docs de Kolibri. Los borradores se completarán en Documentos de Google y puedo ayudarte a convertir los archivos de texto a Markdown o reStructuredText para el producto final.
Cronograma
Este proyecto seguirá los lineamientos de proyectos a largo plazo (26 semanas en total, del 2/9/2019 al 2/28/2020). Pasaré alrededor de 10 horas por semana completando los objetivos que se describen a continuación. Además de estos objetivos, participaré en reuniones de mentorización y comunicación durante este tiempo, según sea necesario. Trabajaré con los mentores para determinar el mejor momento para la situación. La línea de tiempo generalmente se divide en partes de cuatro semanas, donde crearé varios videos, páginas de tutoriales y ejercicios.
Semanas uno y dos
Objetivos:
- Configura el dispositivo personal con los sitios web o las cuentas que se necesiten para acceder a la información.
- Comienza a desarrollar la estructura y un esquema de página más detallado para la página de destino.
- Analiza con los mentores el estilo de los videos y desarrolla una plantilla de pantalla de apertura de video, cualquier música de relleno para el título y las pantallas finales, y la información adicional que se debe incluir.
- Revisa la documentación y la estructura de la documentación actuales para extraer vínculos que puedas usar en recursos adicionales y referencias de instructivos.
De la semana tres a la seis (instructivos para principiantes de nivel 1)
Objetivos:
- Desarrollar el contenido y las lecciones iniciales para el flujo de trabajo de INSTALL-IMPORT/nivel 1 Crea un video para los procesos de descarga, instalación, configuración y importación. Dado que las funciones INSTALL-IMPORT son la base de muchos otros flujos de trabajo y las más utilizadas, se dedicará una gran parte del tiempo a finalizar estos instructivos y lecciones.
- Enfócate en los tipos de ubicación IMPORT y desarrolla un gráfico que muestre al usuario dónde puede adquirir contenido (canales públicos que existen en Kolibri Studio) para la página de destino.
- Desarrollar videos y contenido adicionales para las expansiones de INSTALL-IMPORT (canal de ACTUALIZACIÓN) Estas expansiones también pueden ser recursos adicionales o vínculos a documentación existente.
- Trabajar en los subtítulos de cualquier video
- “Prueba” los videos y pide comentarios a cualquier recurso disponible sobre la usabilidad. Esto incluye volver a revisar la plantilla de los videos y consolidarla para los videos futuros.
Semanas siete a diez (nivel 2: Subir contenido)
Objetivos:
- Enfócate en las lecciones y los videos de flujos de trabajo para el arquetipo del usuario que sube videos a Studio.
- Documentación y lecciones completas para UPLOAD-PUBLISH-IMPORT.
- Desarrolla subtítulos para cualquier video.
De la semana once a la catorce (nivel 3: “remezclador” y editor de contenido)
Objetivos:
- Enfócate en los siguientes flujos de trabajo y crea contenido de instructivos o lecciones: SUBIR-EDITAR-PUBLICAR-ACTUALIZAR y EDITAR-PUBLICAR-ACTUALIZAR.
- Desarrolla los subtítulos de los videos.
De la semana quince a la dieciocho
Objetivos:
- Como se indicó durante mi investigación para esta propuesta, los flujos de trabajo que involucran Ricecooker tienen una prioridad más baja (tipo CHEFDEV). Según el tiempo y el programa, podría usar este tiempo para crear un instructivo de alto nivel que haga referencia a la documentación existente de Ricecooker.
Semanas diecinueve a veintidós
Objetivos:
- Evalúa si hay alguna carencia en este momento y prueba el flujo actual de todos los instructivos.
- Trabaja para finalizar la página de destino y comenzar a vincular los videos.
- Trabaja en la conversión de los borradores de páginas realizados en Documentos de Google a Markdown o reStructuredText, como se analizó con los mentores.
Semanas veintitrés a veinticinco
Objetivos:
- Según el tiempo disponible, termina el trabajo final en los instructivos avanzados de baja prioridad.
- Último minuto Lea la edición de la página de Documentos, la prueba de archivos y la revisión de ortografía y gramática.
- Control de calidad de los vínculos en los videos o en otras páginas
Semana veintiséis
Semana final para los proyectos de larga duración. Trabajaré con los mentores para finalizar los entregables del proyecto y completar cualquier documentación final y obligatoria de Google.
Componentes del instructivo
Página de destino del instructivo
Los usuarios accederán a una página de destino de instructivos en el sitio Read the Docs de Kolibri, que proporcionará un resumen breve de los diversos instructivos que se ofrecen para los flujos de trabajo de contenido. El objetivo de esta página es proporcionar una breve descripción general del ecosistema de Kolibri y una vista gráfica de los diversos flujos de trabajo. Esto le permite al usuario ver el tipo de flujo de trabajo que se adapta a sus necesidades, tanto técnicas como para el plan de estudios de su organización. Los usuarios comprenderán mejor las opciones disponibles en Kolibri y Kolibri Studio.
Páginas de instructivos y lecciones
La página principal de cada tutorial ofrece una introducción al tutorial (compuesto por varias lecciones), seguida de algunos objetivos del usuario. Los tutoriales ilustran todo un flujo de trabajo y se componen de lecciones individuales. Cada lección tendrá un video. Los videos abarcarán una parte individual de un concepto general. Cada lección se mantendrá en una página individual dentro de la página principal del flujo de trabajo del instructivo. Las páginas de las lecciones tendrán botones que permitirán al usuario navegar a la lección anterior o siguiente dentro del instructivo. Los conceptos muy complejos pueden incluir actividades de práctica.
Videos y estructura
Los videos describirán un solo concepto. Los videos te indicarán una dirección mientras realizas esa acción en la pantalla. Aquí puedes ver un ejemplo de video: https://youtu.be/DkMP_VdGslU. Este video de ejemplo muestra cómo utilizar el asistente de configuración.
El video usa textos destacados y un cursor destacado para guiar al usuario a través de los pasos de este único concepto. Los videos se alojarán en YouTube. Si se alojan en YouTube, los subtítulos se generarán automáticamente. Luego, editaré los subtítulos en busca de errores ortográficos, gramaticales y de puntuación. Luego, esos subtítulos se pueden exportar para su traducción en Amara o en otra herramienta de traducción.
Los videos tendrán una pantalla de título coherente, que planeo analizar con los mentores en las primeras semanas. También usaré un estilo de texto destacado coherente (flechas, resaltado del cursor, cuadros), que se decidirá junto con los mentores en las primeras semanas.
Ejemplos de estructuras
El flujo de trabajo más simple, INSTALL-IMPORT, es un instructivo completo. En ese instructivo, hay dos posibles lecciones con un video:
- Descarga, instala y configura tu instalación de Kolibri
- Importación de contenido en Kolibri Studio: Ten en cuenta que otros flujos de trabajo harán referencia a este video
Un instructivo más avanzado requiere varias sublecciones con varios videos. El flujo de trabajo UPLOAD-EDIT-PUBLISH-UPDATE sigue la siguiente estructura.
Lección 1: Sube contenido y crea canales en Kolibri Studio
Objetivos de los usuarios: Al final de esta lección, sabrás cómo realizar las siguientes acciones:
- Crea canales en Kolibri Studio para usarlos en Kolibri. Sabrás cómo usar los tokens secretos de tu canal para importar tu canal de contenido en Kolibri.
- Para crear un canal, importa contenido de canales públicos existentes en la biblioteca de Studio.
- Sube contenido desde tu computadora para crear un canal.
Videos de las subclases:
- Sublección 1: Crea tus propios canales en Kolibri Studio y, luego, importa contenido de canales públicos existentes (Khan Academy, PHET, etcétera): Video 1: Canales de contenido público (ver canales PÚBLICOS en Kolibri Studio) Video 2: Cómo crear un canal Video 3: Cómo importar contenido de canales existentes Video 4: Cómo publicar tu canal y obtener el token secreto Video 5: Cómo importar tu canal a Kolibri con el token secreto
- Sublección 2: Carga de contenido del canal de Mis documentos: Video 1: Cómo subir archivos desde Mis documentos Video 2: Cómo crear tus propios ejercicios
Lección 2: Edición avanzada de canales en Kolibri Studio
Objetivos del usuario: Al final de esta lección, sabrás cómo completar las siguientes acciones:
- Edita canales de contenido en Kolibri Studio
- Administra canales de contenido en Kolibri Studio
Videos de sublecciones:
- Sublección 1: Edita contenido agregando ejercicios, reorganizando la estructura de carpetas y opciones de colaboración (1 video)
- Sublección 2: Cómo usar otras funciones, como borrar o mover contenido (1 video)
Lección 3: Publica canales de Kolibri Studio para usarlos en Kolibri y actualízalos
Objetivos de los usuarios: Al final de esta lección, sabrás cómo realizar las siguientes acciones:
- Publica un canal en Kolibri Studio y vuelve a publicarlo después de agregar contenido nuevo
- Cómo actualizar un canal
- Adquiere el token del canal para importarlo a Kolibri (mediante un vínculo al video anterior en la Lección 1 donde se aborda esta acción)
Videos de sublecciones:
Sublección 1: Cómo publicar actualizaciones en un canal
Video 1: Cómo volver a publicar el canal Video 2: Actualización del canal en Kolibri después de agregar contenido adicional