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:
- A linguagem Julia
- Redator técnico:
- sofb
- Nome do projeto:
- A reinvenção do site do FluxML
- Duração do projeto:
- Duração padrão (3 meses)
Project description
O objetivo desta proposta é melhorar o site de documentação do Flux para que as informações nele contidas sejam estruturadas e atrativas para novatos e especialistas. Mais especificamente, o objetivo é reorganizar a documentação em novas seções e criar um novo tutorial de iniciação para iniciantes que amplie o tutorial do Flux 60-mine-blitz.
O projeto consiste nas seguintes fases:
Analise o site da documentação atual: audite as informações existentes e defina um guia de estilo (para as informações) para criar novos tutoriais.
Defina uma nova estrutura para as informações e o tutorial de primeiros passos: trabalhe com os mentores para determinar as novas seções e reorganizar o site da documentação. Além disso, defina um índice para o tutorial de introdução usando o tutorial Flux 60-mine-blitz como ponto de partida e apoie-o.
Reestruture as informações: atualize o site com o plano definido em colaboração com os mentores na etapa anterior.
Criar o tutorial de iniciação: escreva o primeiro rascunho e revise-o. Obter feedback dos mentores. Quando eu e os mentores determinarmos que temos uma versão final deste documento, iremos publicá-la no site da documentação.
(Opcional) Converta a documentação existente em forma de READMEs para HTML: se eu tiver algum tempo sobrando depois de concluir as quatro fases principais, posso converter os tutoriais existentes que são READMEs para que possam ser mais fáceis de acessar pelo site.
Para alcançar o objetivo do projeto, trabalharei em estreita colaboração com a comunidade do Flux para entender a documentação existente e determinar a melhor abordagem. Sou novata da Julia e acredito que isso será muito útil para determinar o nível certo de informações para o novo tutorial de primeiros passos.
Vou me concentrar em garantir que meu trabalho ajude a comunidade do Flux a integrar novos usos. Além disso, ajudarei usuários experientes a descobrir novos casos de uso e explorar os detalhes do Flux.