Projet Kolibri

Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.

Résumé du projet

Organisation Open Source:

Kolibri

Rédacteur technique:

Danielle V

Nom du projet:

Workflows de contenu Kolibri

Durée du projet:

Exécution longue (5 mois)

Project description

La proposition ci-dessous a été élaborée en menant des recherches et en discutant avec les mentors Kolibri. Ma conversation avec les mentors m’a aidé à développer les personnages utilisateurs dont je parle ci-dessous. En outre, mes discussions m'ont permis de trouver l'idée d'un dépôt/une page de destination pour les tutoriels afin que les utilisateurs puissent choisir le tutoriel qu'ils souhaitent consulter en fonction de leurs besoins.

Présentation

Cette proposition propose une solution pour guider les différents parcours utilisateur qu'un individu peut suivre en important du contenu depuis son ordinateur vers Kolibri Studio, puis depuis Kolibri Studio vers Kolibri. Je propose de créer un référentiel central de tutoriels. L'utilisateur accédera à ces tutoriels via une page de destination. La page de destination fournit un tableau avec des liens vers chaque tutoriel de workflow et indique le type d'utilisateur que le tutoriel pourrait bénéficier. De cette façon, les tutoriels seront plus personnalisés en fonction des besoins et des capacités de l’utilisateur. Un flux de travail (par exemple, INSTALLER-IMPORTER) est illustré par plusieurs leçons. Chaque leçon contient une vidéo. Des vidéos présentent une petite partie du workflow et des concepts individuels sur la façon dont ces workflows connectent les applications Kolibri.

Objectifs principaux

1. Créez une page de destination de tutoriel pour aider les utilisateurs à choisir le workflow qui répond le mieux à leurs besoins. Cette page de destination sera hébergée sur la plate-forme Lire la documentation.

2. Créez des leçons individuelles pour les composants de chaque flux de travail et complétez les leçons difficiles par des exercices.

3. Créez des vidéos interactives pour chaque flux de travail.

Outils de projet

Le travail sera effectué à l'aide d'un logiciel d'enregistrement d'écran. J'ai de l'expérience avec Camtasia, mais j'ai également travaillé avec des logiciels et des logiciels sans frais moins onéreux. L'exemple de vidéo accessible via le lien disponible ici (https://youtu.be/DkMP_VdGslU) a été réalisé à l'aide de Flashback par Blueberry Software, pour lequel je possède actuellement une licence. Je vais créer des sous-titres avec YouTube. Les pages de tutoriels seront hébergées sur le site Read the Docs de Kolibri. Les brouillons seront réalisés dans Google Docs et je peux vous aider à convertir des fichiers texte en Markdown ou reStructuredText pour le produit final.

Temps forts

Ce projet suivra les directives à long terme du projet (26 semaines au total, du 02/09/2019 au 28/02/2020). Je consacrerai environ 10 heures par semaine à atteindre les objectifs décrits ci-dessous. En plus de ces objectifs, je participerai à des réunions de mentorat et je participerai à la communication au cours de cette période, si nécessaire. Je vais travailler avec les mentors afin de déterminer le meilleur moment pour cela. La chronologie est généralement divisée en parties de quatre semaines où je vais créer plusieurs vidéos, pages de tutoriels et exercices.

Remarque :Cette chronologie est flexible et tient compte de l'évolution des besoins organisationnels. Ces délais importants offrent une certaine flexibilité et permettent de changer d'objectif en fonction des besoins.

Semaines 1 et 2

Objectifs :

• Configurez votre appareil personnel avec les sites Web ou comptes nécessaires pour accéder aux informations.
• Commencer à développer une structure et une maquette plus détaillée pour la page d’accueil.
• Discuter avec les mentors du style des vidéos et développer un modèle pour écran d'ouverture de vidéo, toute musique de remplissage pour le titre et les écrans de fin et des informations supplémentaires à inclure.
• Passez en revue la documentation et la structure de documentation actuelles pour extraire les liens et les utiliser dans d'autres ressources et références de tutoriels.

Semaines trois à six (niveau 1 : tutoriels de niveau débutant)

Objectifs :

• Développer le contenu initial et les leçons pour le workflow INSTALL-IMPORT/Niveau 1 Créer une vidéo pour les processus de téléchargement, d'installation, de configuration et d'importation. Étant donné que les fonctions INSTALL-IMPORT constituent la base de nombreux autres flux de travail et qu'elles sont les plus couramment utilisées, une grande partie du temps sera consacrée à la finalisation de ces tutoriels et leçons.
• Concentrez-vous sur les types d'emplacements IMPORT et créez un graphique qui illustre l'endroit où l'utilisateur peut acquérir du contenu (canaux publics disponibles dans Kolibri Studio) pour la page de destination.
• Créez des vidéos et des contenus supplémentaires pour les expansions d'objets INSTALL-IMPORT (chaîne UPDATE). Ces développements peuvent également prendre la forme de ressources supplémentaires ou de liens vers une documentation existante.
• Travaillez sur les sous-titres de toutes vos vidéos.
• des vidéos de « test » et demandez l'avis des ressources disponibles concernant la facilité d’utilisation. Cela inclurait de revoir le modèle pour les vidéos et de le consolider pour les prochaines vidéos.

Semaines 7 à 10 (niveau 2 - Mise en ligne de contenus)

Objectifs :

• Concentrez-vous sur les leçons et les vidéos sur les processus destinées au persona de mise en ligne de Studio.
• Documentation complète et leçons pour IMPORTER, PUBLIER ET IMPORTER.
• Créez des sous-titres pour toutes les vidéos.

Semaines 11 à 14 (niveau 3 : Éditeur de contenu et éditeur de contenus)

Objectifs :

• Concentrez-vous sur les flux de travail suivants et créez du contenu de tutoriel/leçon: UPLOAD-EDIT-PUBLISH-UPDATE et EDIT-PUBLISH-UPDATE.
• Créez des sous-titres pour les vidéos.

Semaines 15 à 18

Objectifs :

• Comme indiqué lors de mes recherches pour cette proposition, les flux de travail impliquant un Cuiseur de riz sont de priorité inférieure (type CHEFDEV). Selon le calendrier et le calendrier, je pourrais utiliser ce temps pour créer un tutoriel de haut niveau qui se réfère à la documentation existante de Ricecooker.

Semaines 19 à vingt-deux

Objectifs :

• Évaluez les lacunes à ce stade et testez le flux actuel de tous les tutoriels.
• Travaillez à la finalisation de la page de destination et commencez à associer les vidéos.
• Travaillez à la conversion de brouillons de pages réalisés dans Google Docs en Markdown ou reStructuredText, comme nous l'avons vu avec les mentors.

Semaines vingt-trois à vingt-cinq

Objectifs :

• Si vous avez assez de temps, terminez vos derniers travaux sur des tutoriels avancés à faible priorité.
• Dernière minute : lire la page Google Docs, tester des fichiers et vérifier la grammaire et l'orthographe.
• Contrôlez la qualité de tous les liens dans les vidéos ou sur d'autres pages.

Semaine 26

Dernière semaine pour les projets de longue durée. Je collaborerai avec les mentors pour conclure les produits livrables du projet et remplir tous les documents Google finaux requis.

Composants du tutoriel

Page de destination du tutoriel

Les utilisateurs accèdent à une page de destination sur le site Read the Docs de Kolibri, qui présente brièvement les différents tutoriels proposés pour les flux de travail liés aux contenus. L'objectif de cette page est de présenter brièvement l'écosystème Kolibri ainsi qu'une vue graphique des différents flux de travail. Cela permet à l'utilisateur de visualiser le type de flux de travail qui répond à ses besoins, tant sur le plan technique que du programme de l'organisation. Les utilisateurs comprennent mieux les options qui s'offrent à eux dans Kolibri et Kolibri Studio.

Pages de tutoriels et de leçons

Chaque page d'accueil du tutoriel contient une introduction au tutoriel (composé de plusieurs leçons), suivi de certains objectifs de l'utilisateur. Les tutoriels illustrent l'intégralité d'un flux de travail et se composent de leçons individuelles. Chaque leçon comprendra une vidéo. Les vidéos couvrent une partie individuelle d'un concept global. Chaque leçon sera conservée sur une page individuelle de la page parent du workflow du tutoriel. Les pages de cours comportent des boutons qui permettent à l'utilisateur d'accéder à la leçon précédente ou suivante du tutoriel. Les concepts très complexes peuvent inclure des activités pratiques.

Vidéos et structure

Les vidéos décrivent un seul concept. Les vidéos guident l'utilisateur lors de l'exécution de cette action à l'écran. Voici un exemple de vidéo: https://youtu.be/DkMP_VdGslU. Cette vidéo d'exemple montre comment utiliser l'assistant de configuration.

Remarque :Bien que cette vidéo illustre du contenu existant, elle vise à montrer la façon dont les accroches et la mise en surbrillance du curseur peuvent être utilisées pour créer un style vidéo cohérent.

La vidéo utilise des accroches et un curseur en surbrillance pour guider l'utilisateur tout au long des étapes de ce concept unique. Les vidéos seront hébergées sur YouTube. Si elles sont hébergées sur YouTube, les sous-titres sont générés automatiquement. Je modifierai ensuite les sous-titres pour l'orthographe, la grammaire et la ponctuation. Vous pouvez ensuite exporter ces sous-titres pour les traduire dans Amara ou un autre outil de traduction.

Les vidéos auront un écran de titre cohérent, dont je compte parler avec les mentors au cours des deux premières semaines. Je vais également utiliser un style d'accroche cohérent (flèches, mise en surbrillance du curseur, cases), qui sera décidé avec les mentors au cours des deux premières semaines.

Exemples de structures

Le workflow le plus simple, INSTALL-IMPORT, est un tutoriel complet. Ce tutoriel comporte deux leçons potentielles accompagnées d'une vidéo:

• Téléchargement, installation et configuration de votre installation Kolibri
• Importation de contenu dans Kolibri Studio : d'autres flux de travail permettent d'accéder à cette vidéo.

Un tutoriel plus avancé nécessite plusieurs sous-leçons avec plusieurs vidéos. Le flux de travail IMPORTER-MODIFIER-PUBLIER-METTRE À JOUR suit la structure ci-dessous.

Remarque :Si ce workflow se trouve en dehors des pages Kolibri Studio et que c'est la première fois que Kolibri Studio est présenté, la page de présentation du cours pour ces vidéos fournit des liens permettant de se connecter et de créer un compte Studio. Les sous-leçons sont des pages individuelles. Par conséquent, en raison de la complexité de ce processus, chaque sous-leçon contient plusieurs vidéos.

Leçon 1 : Mettre en ligne des contenus et créer des chaînes dans Kolibri Studio

Objectifs de l'utilisateur: à la fin de cette leçon, vous saurez comment effectuer les actions suivantes:

• Créez des chaînes dans Kolibri Studio pour les utiliser dans Kolibri. Vous saurez comment utiliser les jetons secrets de votre chaîne pour importer votre chaîne de contenu dans Kolibri.
• Créez une chaîne en important le contenu de chaînes publiques existantes dans la bibliothèque Studio.
• Créez une chaîne en mettant en ligne du contenu depuis votre ordinateur.

Vidéos de la sous-leçon:

• Sous-leçon 1 – Créer vos propres chaînes sur Kolibri Studio et importer le contenu de chaînes publiques existantes (Khan Academy, PHET, etc.) Vidéo 1 : Chaînes de contenu publiques (vues de chaînes PUBLIQUES sur Kolibri Studio) Vidéo 2 – Créer une chaîne Vidéo 3 – Importer du contenu à partir de chaînes existantes Vidéo 4 – Publier votre chaîne et obtenir le jeton secret Vidéo 5 – Importer votre chaîne dans Kolibri à l'aide du jeton secret
• Sous-leçon 2 – Mise en ligne de la chaîne "Mes documents" : Vidéo 1 – Importer des fichiers à partir de Mes documents Vidéo 2 – Créer vos propres exercices

Leçon 2 : Modification avancée des chaînes dans Kolibri Studio

Objectifs de l'utilisateur: à la fin de cette leçon, vous saurez comment effectuer les actions suivantes:

• Modifier des chaînes de contenu dans Kolibri Studio
• Gérer des chaînes de contenu dans Kolibri Studio

Vidéos de la sous-leçon:

• Sous-leçon 1 : Modifier du contenu par l'ajout d'exercices, la réorganisation de la structure des dossiers et des options de collaboration (1 vidéo)
• Sous-leçon 2 : Utiliser d'autres fonctions, comme supprimer ou déplacer du contenu (1 vidéo)

Leçon 3 : Publier des chaînes Kolibri Studio pour les utiliser dans Kolibri et les mettre à jour

Objectifs de l'utilisateur: à la fin de cette leçon, vous saurez comment effectuer les actions suivantes:

• Publier une chaîne dans Kolibri Studio et la republier après avoir ajouté de nouveaux contenus
• Mettre à jour une chaîne
• Obtenez un jeton de chaîne à importer dans Kolibri (via un lien vers la vidéo précédente de la leçon 1 qui explique cette action)

Vidéos de la sous-leçon:

• Sous-leçon 1 : Publier des informations sur une chaîne

  Vidéo 1: Republier la chaîne Vidéo 2: Mettre à jour la chaîne sur Kolibri après avoir ajouté du contenu