Projeto Kolibri

Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.

Resumo do projeto

Organização de código aberto:

Kolibri

Redator técnico:

Danielle V

Nome do projeto:

Fluxos de trabalho de conteúdo da Kolibri

(em inglês)

Duração do projeto:

Longa duração (cinco meses)

Project description

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

Visão geral

Esta proposta apresenta uma solução para orientar as várias jornadas do usuário em que um indivíduo pode importar conteúdo do computador para o Kolibri Studio e, em seguida, do Kolibri Studio para o Kolibri. Proponho a criação de um repositório central de tutoriais. O usuário vai acessar esses tutoriais em uma página de destino. A página de destino vai mostrar uma tabela com links para cada tutorial de fluxo de trabalho e indicar o tipo de usuário que pode se beneficiar dele. Dessa forma, os tutoriais serão mais personalizados para 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 demonstram conceitos individuais sobre como esses fluxos de trabalho conectam os aplicativos Kolibri.

Metas principais

1. Crie uma página de destino com um tutorial que ajude os usuários a decidir qual fluxo de trabalho é mais adequado para eles. Esta página de destino ficará hospedada na plataforma Read the Docs.

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

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

Ferramentas de projeto

O trabalho será feito usando um software de screencasting. Tenho experiência com o Camtasia, mas também trabalhei com softwares e freewares menos caros. O vídeo de exemplo que está vinculado aqui (https://youtu.be/DkMP_VdGslU) foi feito com o Flashback da Blueberry Software, para o qual tenho uma licença. Vou criar legendas usando o YouTube. As páginas de tutoriais serão hospedadas no site Read the Docs da Kolibri. O trabalho de rascunho será concluído nos Documentos Google, e posso ajudar a converter arquivos de texto em Markdown ou reStructuredText para o produto final.

Cronograma

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

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

Primeira e segunda semanas

Metas:

• Configure o dispositivo pessoal com todos os sites ou contas necessários para acessar informações.
• Começar a desenvolver uma estrutura e um wireframe mais detalhado para a página de destino.
• Converse com os mentores sobre o estilo dos vídeos, além de desenvolver um modelo para a tela de abertura do vídeo, uma música complementar para as telas inicial e final e outras informações que precisam ser incluídas.
• Analisar a documentação atual e a estrutura de documentação para extrair links para uso em outros recursos e referências de tutoriais.

Semanas 3 a 6 (tutoriais de nível 1 para iniciantes)

Metas:

• Desenvolver 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 usadas, uma grande parte do tempo será dedicada à conclusão desses tutoriais e lições.
• Concentre-se nos tipos de local de IMPORTAÇÃO e desenvolva um gráfico que mostre ao usuário onde ele pode adquirir conteúdo (canais públicos que existem no Kolibri Studio) para a página de destino.
• Desenvolva outros vídeos e conteúdo para expandir o canal INSTALL-IMPORT (UPDATE). Essas expansões também podem vir na forma de recursos adicionais ou links para documentação existente.
• Trabalhe em legendas para qualquer vídeo.
• “Testar” vídeos e pedir feedback de quaisquer recursos disponíveis relacionados à usabilidade. Isso inclui revisar o modelo de vídeos e solidificá-lo para vídeos futuros.

Semanas de 7 a 10 (nível 2: usuário que fez o envio de conteúdo)

Metas:

• Concentre-se em vídeos de aprendizado e fluxos de trabalho para o perfil de usuário do Studio Uploader.
• Complete a documentação e as lições sobre UPLOAD-PUBLISH-IMPORTAR.
• Crie legendas para qualquer vídeo.

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

Metas:

• Concentre-se nos seguintes fluxos de trabalho e crie conteúdo de tutorial/aula: UPLOAD-EDIT-PUBLISH-UPDATE e EDIT-PUBLISH-UPDATE.
• Criar legendas para vídeos.

Semanas 15 a 18

Metas:

• Como foi transmitido durante minha pesquisa para esta proposta, os fluxos de trabalho que envolvem o Ricecooker têm prioridade menor (tipo CHEFDEV). Dependendo do tempo e da programação, posso usar este tempo para criar um tutorial de alto nível que se refira à documentação atual do Ricecooker.

Semanas 19 a 22

Metas:

• Avalie as lacunas 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.
• Converter rascunhos de páginas feitos nos Documentos Google em Markdown ou reStructuredText, conforme discutido com os mentores.

De 23 a 25 semanas

Metas:

• Dependendo do tempo, termine qualquer trabalho final em tutoriais avançados de baixa prioridade.
• De última hora. Leia a edição da página do Documentos, o teste de arquivos e a verificação de gramática/ortografia.
• Controle de qualidade de todos os links em vídeos ou em outras páginas.

Semana 26

Semana final para projetos de longa duração. Vou trabalhar com mentores para concluir os resultados do projeto e preencher toda a 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 de tutorial no site Read the Docs da Kolibri, que vai mostrar 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 do Kolibri e uma visão gráfica dos vários fluxos de trabalho. Isso permite que o usuário visualize o tipo de fluxo de trabalho que atende às necessidades dele, tanto tecnicamente quanto para 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 lições

Cada página inicial de tutorial fornecerá uma introdução ao tutorial (composta por várias lições), seguida por alguns objetivos do usuário. Os tutoriais ilustram todo um fluxo de trabalho e são compostos de lições individuais. Cada aula terá um vídeo. Os vídeos vão abordar uma parte específica de um conceito geral. Cada lição será mantida em uma página individual na página principal do fluxo de trabalho do tutorial. As páginas da lição terão botões que permitem ao usuário navegar para a lição anterior ou para a próxima do tutorial. Conceitos muito complexos podem incluir atividades práticas.

Vídeos e estrutura

Os vídeos vão descrever um único conceito. Os vídeos vão dar uma direção ao realizar 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 Configuração.

Observação: embora este vídeo exemplifique o conteúdo existente, ele tem como objetivo mostrar como os destaques e os cursores podem ser usados para criar um estilo de vídeo consistente.

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

Os vídeos terão uma tela de título consistente, que pretendo discutir com os mentores nas primeiras semanas. Também vou usar um estilo consistente de chamada (setas, destaque do cursor, caixas), que será decidido com os mentores nas primeiras semanas.

Exemplos de estruturas

O fluxo de trabalho mais simples, INSTALL-IMPORT, é um tutorial completo. Nesse tutorial, há duas lições possíveis com um vídeo:

• Como fazer o download, instalar e configurar o Kolibri Facility
• Como importar conteúdo no Kolibri Studio: outros fluxos de trabalho vão se referir a este vídeo

Um tutorial mais avançado exige várias subaulas com vários 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 apresentado, a página de introdução da lição desses vídeos vai fornecer links para fazer login e criar uma conta do Studio. As sublições são páginas individuais. Portanto, devido à maior complexidade desse fluxo de trabalho, cada sublição contém vários vídeos.

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

Metas do usuário: ao final desta lição, você vai saber como concluir 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 fazendo upload de conteúdo do seu computador.

Vídeos de subaulas:

• Sublição 1: crie seus próprios canais no Kolibri Studio e importe conteúdo de canais públicos (Khan Academy, PHET etc.): Vídeo 1: canais de conteúdo público (como acessar canais PÚBLICOS 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: envio de conteúdo do canal Meus documentos: Vídeo 1: envio de arquivos do 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ê vai saber como concluir as seguintes ações:

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

Vídeos de subaulas:

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

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

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

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

Vídeos de subaulas:

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

  Vídeo 1: republicação do canal Vídeo 2: Atualização do canal em Kolibri depois de adicionar mais conteúdo