Projeto Kolibri

Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.

Resumo do projeto

Organização de código aberto:

Kolibri

(link em inglês)

Redator técnico:

Danielle V

Nome do projeto:

Fluxos de trabalho de conteúdo do Kolibri

Duração do projeto:

De longa duração (5 meses)

Project description

A proposta abaixo foi criada com a realização de pesquisas e conversas com os mentores da Kolibri. Minha conversa com os mentores me ajudou a desenvolver as personas de usuário discutidas abaixo. Além disso, minhas discussões me ajudaram a ter a ideia de um repositório de tutoriais/página de destino para que os usuários possam escolher qual tutorial eles querem ver de acordo com suas necessidades.

Visão geral

Esta proposta apresenta uma solução para orientar as várias jornadas do usuário que um indivíduo pode fazer ao importar conteúdo do computador para o Kolibri Studio e depois do Kolibri Studio para o Kolibri. Proponho a criação de um repositório central de tutoriais. O usuário acessará esses tutoriais em uma página de destino. A página de destino fornecerá uma tabela com links para cada tutorial de fluxo de trabalho e indicará o tipo de usuário que o tutorial poderia se beneficiar. Dessa forma, os tutoriais serão mais personalizados de acordo com as necessidades e habilidades do usuário. Um fluxo de trabalho (por exemplo, INSTALL- IMPORT) é demonstrado em várias lições. Cada lição contém um vídeo. Os vídeos mostram uma pequena parte do fluxo de trabalho e apresentam conceitos individuais sobre como eles conectam os aplicativos da Kolibri.

Principais metas

1. Crie uma página de destino de tutorial que ajude os usuários a decidir qual fluxo de trabalho atende melhor às necessidades deles. Esta página de destino será hospedada na plataforma "Ler os documentos".

2. Crie aulas individuais para os componentes de cada fluxo de trabalho e complemente as lições difíceis com exercícios.

3. Crie vídeos interativos para cada fluxo de trabalho.

Ferramentas de projeto

O trabalho vai ser feito com um software de screencasting. Eu tenho experiência com o Camtasia, mas também trabalhei com software e softwares sem custos financeiros menos proibidos. O vídeo de exemplo neste link (https://youtu.be/DkMP_VdGslU) foi feito com o Flashback da Blueberry Software, para o qual tenho uma licença atual. Vou criar legendas usando o YouTube. As páginas de tutoriais serão hospedadas no site Leia o documento da Kolibri (em inglês). O rascunho será concluído nos Documentos Google, e posso ajudar a converter arquivos de texto para Markdown ou reStructuredText para o produto final.

Cronograma

Este projeto seguirá as diretrizes de longo prazo (26 semanas no total, de 02/09/2019 a 28/02/2020). Vou usar cerca de 10 horas por semana para concluir as metas descritas abaixo. Além desses objetivos, participarei de reuniões de mentoria e comunicação durante esse período, conforme necessário. Vou trabalhar com os mentores para determinar o melhor horário para isso. O cronograma geralmente é dividido em blocos de quatro semanas, nos quais criarei vários vídeos, páginas de tutoriais e exercícios.

Observação :este cronograma é flexível e reconhece o fato de que as necessidades organizacionais podem mudar. Os prazos longos permitem flexibilidade e a capacidade de mudar o foco conforme necessário.

Primeira e segunda semanas

Metas:

• Configure o dispositivo pessoal com os sites ou as contas necessários para acessar as informações.
• Começar a desenvolver uma estrutura e um wireframe mais detalhado para a página de destino.
• Discuta com os mentores o estilo dos vídeos, elabore um modelo de tela de abertura do vídeo, alguma música para preencher o título e as telas finais e informações adicionais que precisam ser incluídas.
• Revise a documentação atual e a estrutura de documentação para extrair links para uso em recursos adicionais e referências de tutoriais.

Semanas três a seis (nível 1: tutoriais para iniciantes)

Metas:

• Desenvolva o conteúdo inicial e as lições para o fluxo de trabalho INSTALL-IMPORT/Nível 1. Crie vídeos para os processos de download, instalação, configuração e importação. Como as funções INSTALL-IMPORT são a base de muitos outros fluxos de trabalho e as mais comumente usadas, uma grande parte do tempo será dedicada à finalização desses tutoriais e aulas.
• Concentre-se em IMPORTAR tipos de local e desenvolva um gráfico que exemplifique o usuário onde ele pode adquirir conteúdo (canais públicos que existem no Kolibri Studio) para a página de destino.
• Desenvolva mais vídeos e conteúdos para expansões de INSTALL-IMPORT (UPDATE canal). Essas expansões também podem vir na forma de recursos adicionais ou links para documentação existente.
• Trabalhe com legendas em todos os vídeos.
• “Teste” os vídeos e peça feedback de quaisquer recursos disponíveis sobre usabilidade. Isso incluiria rever o modelo para vídeos e solidificar o modelo para vídeos futuros.

Semanas de sete a dez (nível 2: ferramenta de envio de conteúdo)

Metas:

• Concentre-se em aulas e vídeos com fluxo de trabalho para o perfil da pessoa que fez o envio do Studio.
• Documentação e lições completas para UPLOAD-PUBLISH-IMPORT.
• Desenvolva legendas para todos os vídeos.

Semanas de 11 a 14 (nível 3: "remixer" e editor de conteúdo)

Metas:

• Concentre-se nos seguintes fluxos de trabalho e crie tutoriais/conteúdos: UPLOAD-EDIT-PUBLISH-UPDATE e EDIT-PUBLISH-UPDATE.
• Desenvolva legendas para os vídeos.

Semanas 15 a 18

Metas:

• Como informado durante minha pesquisa para esta proposta, os fluxos de trabalho que envolvem panela de arroz têm prioridade mais baixa (tipo CHEFDEV). Dependendo do tempo e do cronograma, eu poderia usar esse tempo para criar um tutorial de alto nível que se refere à documentação existente para panela de arroz.

De 19 a 22 semanas

Metas:

• Avalie as lacunas nesse momento e teste o fluxo atual de todos os tutoriais.
• Trabalhe na finalização da página de destino e comece a vincular os vídeos.
• Trabalhe com a conversão de rascunhos de páginas feitos nos Documentos Google para Markdown ou reStructuredText, conforme discutido com os mentores.

Entre 23 e 25

Metas:

• Dependendo do tempo, conclua qualquer trabalho final em tutoriais avançados de baixa prioridade.
• Leia sobre edição de páginas do Documentos Google, teste de arquivos e verificação ortográfica/gramatical.
• Faça o controle de qualidade de links em vídeos ou em outras páginas.

Semana 26

Última semana para projetos de longa duração. Trabalharei com mentores para finalizar as entregas do projeto e finalizar qualquer documentação final necessária do Google.

Componentes do tutorial

Página de destino do tutorial

Os usuários vão acessar uma página de destino no site Leia os Documentos da Kolibri, que apresenta um breve resumo dos vários tutoriais oferecidos para fluxos de trabalho de conteúdo. O objetivo desta página é fornecer uma breve visão geral do ecossistema Kolibri, além de apresentar uma visão gráfica dos vários fluxos de trabalho. Isso dá ao usuário a capacidade de visualizar o tipo de fluxo de trabalho que atende às necessidades dele, tanto tecnicamente quanto de acordo com o currículo da organização. Os usuários vão entender melhor as opções disponíveis no Kolibri e no Kolibri Studio.

Páginas de tutoriais e aulas

Cada página inicial do tutorial apresenta uma introdução ao tutorial (composto por várias lições) seguida por algumas metas do usuário. Os tutoriais ilustram um fluxo de trabalho completo e são compostos por lições individuais. Cada aula terá um vídeo. Os vídeos abrangem uma parte individual de um conceito geral. Cada lição será mantida em uma página individual dentro da página principal do fluxo de trabalho do tutorial. As páginas da lição têm botões que permitem ao usuário navegar para a lição anterior ou para a próxima no tutorial. Conceitos muito complexos podem incluir atividades práticas.

Vídeos e estrutura

Os vídeos apresentarão um único conceito. Os vídeos vão indicar uma direção enquanto executam essa ação na tela. Confira um exemplo de vídeo aqui: https://youtu.be/DkMP_VdGslU. Este vídeo de exemplo mostra como usar o assistente do recurso de configuração.

Observação: este vídeo é um exemplo do conteúdo atual, mas o objetivo dele é mostrar como as frases de destaque e os destaques de cursor podem ser usados para criar um estilo consistente.

O vídeo usa frases de destaque e um cursor em destaque para ajudar a guiar o usuário pelas etapas desse único conceito. Os vídeos serão hospedados no YouTube. Se estiverem hospedadas no YouTube, as legendas serão geradas automaticamente. Em seguida, editarei as legendas para ortografia, gramática e pontuação. Essas legendas podem ser exportadas para traduções no Amara ou em outra ferramenta de tradução.

Os vídeos terão uma tela de título consistente, que pretende discutir com os mentores nas primeiras semanas. Também usarei um estilo de frase de destaque consistente (setas, destaque de cursor, caixas), que será decidido em conjunto com os mentores nas primeiras semanas.

Exemplos de estruturas

O fluxo de trabalho mais simples, INSTALL-IMPORT, é um tutorial inteiro. Nesse tutorial, há duas possíveis aulas com um vídeo:

• Como fazer o download, instalar e configurar sua instalação da Kolibri
• Importação de conteúdo no Kolibri Studio: esse vídeo é mencionado em outros fluxos de trabalho.

Um tutorial mais avançado requer várias sublições com diversos vídeos. O fluxo de trabalho UPLOAD-EDIT-PUBLISH-UPDATE segue a estrutura abaixo.

Observação: se esse fluxo de trabalho estiver fora das páginas do Kolibri Studio e for a primeira vez que o Kolibri Studio for lançado, a página de introdução da aula para esses vídeos fornecerá links para fazer login e criar uma conta do Studio. As sublições são páginas individuais. Por isso, como esse fluxo de trabalho é muito complexo, cada uma delas tem vários vídeos.

Lição 1: como enviar conteúdo e criar canais no Kolibri Studio

Metas do usuário: ao final desta lição, você saberá como realizar as seguintes ações:

• Crie canais no Kolibri Studio para uso no Kolibri. Você vai saber como usar os tokens secretos do seu canal para importar o canal de conteúdo no Kolibri.
• Crie um canal importando conteúdo de canais públicos existentes na biblioteca do Studio.
• Crie um canal enviando conteúdo do seu computador.

Vídeos de subaula:

• Sublição 1: crie seus próprios canais no Kolibri Studio e importe conteúdo de canais públicos existentes (Khan Academy, PHET etc.): Vídeo 1 - Canais de conteúdo público (visualização de canais PUBLIC no Kolibri Studio) Vídeo 2: como criar um canal Vídeo 3: Como importar conteúdo de canais existentes Vídeo 4: como publicar seu canal e receber o token secreto Vídeo 5: como importar seu canal para o Kolibri usando o token secreto
• Sublição 2 — Upload do canal de conteúdo "Meus documentos": Vídeo 1 – Como fazer upload de arquivos de "Meus documentos" Vídeo 2: como criar seus próprios exercícios

Lição 2: Edição avançada de canais no Kolibri Studio

Metas do usuário: ao final desta lição, você saberá como realizar as seguintes ações:

• Editar canais de conteúdo no Kolibri Studio
• Gerenciar canais de conteúdo no Kolibri Studio

Vídeos de subaula:

• Sublição 1: como editar conteúdo adicionando exercícios, reorganizando a estrutura de pastas e opções de colaboração (1 vídeo)
• Sublição 2: usar outras funções, como excluir/mover conteúdo (1 vídeo)

Lição 3: como publicar canais do Kolibri Studio para uso no Kolibri e atualizar canais

Metas do usuário: ao final desta lição, você saberá como realizar as seguintes ações:

• Publicar um canal no Kolibri Studio e publicar novamente depois que novo conteúdo for adicionado
• Atualizar um canal
• Adquira o token do canal para importar para o Kolibri usando um link para o vídeo anterior da Lição 1 que aborda essa ação.

Vídeos de subaula:

• Sublição 1: como publicar atualizações em um canal

  Vídeo 1: republicação do canal Vídeo 2: Como atualizar o canal no Kolibri depois de adicionar mais conteúdo