Esta página contiene 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
- Escritor técnico:
- Daniela V
- Nombre del proyecto:
- Flujos de trabajo del contenido de Kolibri
- Duración del proyecto:
- Larga duración (5 meses)
Project description
La siguiente propuesta se creó realizando una investigación y hablando con los mentores de Kolibri. Mi conversación con los mentores me ayudó a desarrollar las personas de usuario que analizaré a continuación. Además, mis charlas me ayudaron a pensar en la idea de crear un repositorio/página de destino de tutoriales para que los usuarios tengan la opción de qué tutorial desean ver según sus necesidades.
Descripción general
Esta propuesta presenta una solución para guiar los distintos recorridos del usuario que una persona puede llevar al 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 podría beneficiarse el instructivo. De esta manera, los tutoriales serán más personalizados según las necesidades y habilidades del usuario. En múltiples lecciones, se demuestra un flujo de trabajo (por ejemplo, INSTALL-IMPORT). Cada lección tiene 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 del 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 Leer la plataforma de Documentos.
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 del proyecto
El trabajo se realizará con un software de presentación en pantalla. Tengo experiencia con Camtasia, pero también trabajé con software gratuito y menos costosos. El video de muestra vinculado aquí (https://youtu.be/DkMP_VdGslU) se creó con Flashback de Blueberry Software, para el que actualmente tengo una licencia. Crearé los subtítulos en YouTube. Las páginas de instructivos se alojarán en el sitio Read the Docs de Kolibri. El borrador se completará en Documentos de Google, y puedo ayudarte a convertir archivos de texto a Markdown o reStructuredText para el producto final.
Cronograma
Este proyecto seguirá los lineamientos del proyecto a largo plazo (26 semanas en total, del 2 de septiembre de 2019 al 28 de febrero de 2020). Dedicaré alrededor de 10 horas por semana a completar los objetivos que se describen a continuación. Además de estos objetivos, participaré en reuniones con mentores y en comunicaciones durante este período, según sea necesario. Trabajaré con los mentores para determinar el mejor momento para esto. El cronograma se divide generalmente en cuatro semanas, en los que crearé varios videos, páginas de tutoriales y ejercicios.
Semanas uno y dos
Objetivos:
- Configura tu dispositivo personal con los sitios web o las cuentas que necesites para acceder a la información.
- Comienza a desarrollar una estructura y un esquema de página más detallado para la página de destino.
- Conversa con los mentores sobre el estilo de los videos y desarrolla una plantilla para la pantalla de apertura del video, música de relleno para el título y las pantallas finales e información adicional que se debe incluir.
- Revisa la documentación actual y su estructura para extraer vínculos y usarlos en recursos adicionales y referencias de instructivos.
Semanas tres a seis (nivel 1: Instructivos para principiantes)
Objetivos:
- Desarrolla contenido inicial y lecciones para el flujo de trabajo INSTALL-IMPORT/Nivel 1. Crea un video para los procesos de descarga, instalación, configuración e importación. Dado que las funciones INSTALL-IMPORT son la base de muchos otros flujos de trabajo y son las más usadas, se dedicará una gran parte del tiempo a finalizar estos instructivos y lecciones.
- Enfócate en la función IMPORTAR tipos de ubicación y desarrolla un gráfico que ejemplifique para el usuario, donde puede adquirir contenido (canales públicos que existen en Kolibri Studio) para la página de destino.
- Desarrolla videos y contenido adicionales para las expansiones de INSTALL-IMPORT (UPDATE canal). Estas expansiones también podrían presentarse en forma de recursos adicionales o vínculos a documentación existente.
- Trabaja en subtítulos para cualquier video.
- "Probar" videos y pedirles comentarios a los recursos disponibles sobre la usabilidad. Esto incluiría volver a visitar la plantilla para los videos y consolidarla para futuros videos.
Semanas siete a diez (nivel 2: cargador de contenido)
Objetivos:
- Enfócate en las lecciones y los videos del flujo de trabajo para el arquetipo de Cargador de Studio.
- Completa la documentación y las lecciones para SUBIR-PUBLICAR-IMPORTAR.
- Desarrolla subtítulos para cualquier video.
Semanas once a catorce (nivel 3 - "Remixer" de contenido y editor)
Objetivos:
- Enfócate en los siguientes flujos de trabajo y crea contenido de instructivos o lecciones: UPLOAD-EDIT-PUBLISH-UPDATE y EDIT-PUBLISH-UPDATE.
- Crear subtítulos para los videos
Semanas quince a dieciocho
Objetivos:
- Como se transmitió durante mi investigación para esta propuesta, los flujos de trabajo que involucran a Ricecooker son de menor prioridad (tipo CHEFDEV). Según los tiempos y el cronograma, 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 los vacíos en este momento y prueba el flujo actual de todos los instructivos.
- Trabaja en la finalización de la página de destino y comienza a vincular los videos.
- Trabaja en la conversión de borradores de páginas realizados en Documentos de Google en Markdown o reStructuredText, como se conversó con los mentores.
Semanas veintitrés a veinticinco
Objetivos:
- Según el tiempo, finaliza cualquier trabajo final en los instructivos avanzados y de baja prioridad.
- Último minuto: Lee las ediciones de la página de Documentos, las pruebas de archivos y la revisión de ortografía y gramática.
- Controla la calidad de los vínculos que aparecen en videos o en otras páginas.
Semana veintiséis
Última semana para los proyectos de larga duración. Trabajaré con los mentores para finalizar los entregables del proyecto y completar la documentación final que se requiera de Google.
Componentes del instructivo
Página de destino del instructivo
Los usuarios accederán a una página de destino con un instructivo en el sitio Read the Docs de Kolibri, en la que se proporciona un breve resumen de los diversos instructivos disponibles 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 distintos flujos de trabajo. Esto permite que el usuario vea el tipo de flujo de trabajo que se adapta a sus necesidades, tanto a nivel técnico 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
Cada página principal de un tutorial incluirá una introducción al tutorial (que consta de 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 cubrirán una parte individual de un concepto general. Cada lección se almacenará en una página individual dentro de la página principal del flujo de trabajo del instructivo. Las páginas de lecciones incluirán botones que permiten al usuario navegar a la lección anterior o siguiente dentro del tutorial. 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 cómo realizar la acción en la pantalla. Aquí encontrarás un ejemplo de video: https://youtu.be/DkMP_VdGslU. En este video de ejemplo, se muestra cómo usar el asistente de instalación.
El video utiliza textos destacados y un cursor destacado para guiar al usuario a través de los pasos de este concepto único. Los videos se alojarán en YouTube. Si están alojados en YouTube, los subtítulos se generarán automáticamente. Luego, editaré los subtítulos para verificar la ortografía, la gramática y la puntuación. Luego, puedes exportarlos para traducirlos en Amara o alguna otra herramienta de traducción.
Los videos tendrán una pantalla de título consistente, que pienso analizar con los mentores en las primeras semanas. También usaré un estilo de texto destacado coherente (flechas, cursor destacado, cuadros), que se decidirá junto con los mentores en las primeras semanas.
Estructuras de ejemplo
El flujo de trabajo más simple, INSTALL-IMPORT, es un instructivo completo. Dentro de ese tutorial, hay dos posibles lecciones con un video:
- Cómo descargar, instalar y configurar tu instalación de Kolibri
- Cómo importar 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 sublección con varios videos. El flujo de trabajo SUB-EDIT-PUBLISH-UPDATE sigue la estructura que se indica a continuación.
Lección 1: Cómo subir contenido y crear canales en Kolibri Studio
Objetivos del usuario: 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 utilizar 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.
- Para crear un canal, sube contenido desde tu computadora.
Videos de las subclases:
- Sublección 1: Crea tus propios canales en Kolibri Studio e importa contenido de canales públicos existentes (Khan Academy, PHET, etc.): Video 1: Canales de contenido público (cómo ver canales PÚBLICOS en Kolibri Studio) Video 2: Cómo crear un canal Video 3: Importar contenido de canales existentes Video 4: 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 del canal del contenido 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 realizar las siguientes acciones:
- Cómo editar canales de contenido en Kolibri Studio
- Cómo administrar canales de contenido en Kolibri Studio
Videos de las subclases:
- Sublección 1: Cómo editar el contenido agregando ejercicios, reorganizando la estructura de las carpetas y las opciones de colaboración (1 video)
- Sublección 2: Uso de otras funciones, como borrar o mover contenido (1 video)
Lección 3: Cómo publicar canales de Kolibri Studio para usarlos en Kolibri y actualizar canales
Objetivos del usuario: Al final de esta lección, sabrás cómo realizar las siguientes acciones:
- Publicar un canal en Kolibri Studio y volver a publicarlo después de que se agrega contenido nuevo
- Cómo actualizar un canal
- Adquiere el token del canal para importar a Kolibri (mediante un vínculo al video anterior de la Lección 1 que trata esta acción)
Videos de las subclases:
Sublección 1: Cómo publicar actualizaciones de un canal
Video 1: Volver a publicar el canal Video 2: Actualiza el canal en Kolibri después de agregar contenido adicional