Esta página contém os detalhes de um projeto de escrita técnica aceito para o Temporada dos Documentos Google.
Resumo do projeto
- Organização de código aberto:
- A linguagem Julia
- Redator técnico:
- sophb
- Nome do projeto:
- Reinventando o site da FluxML
- Duração do projeto:
- Duração padrão (três meses)
Project description
Esta proposta visa melhorar o site de documentação do Flux para que as informações contidas nele sejam estruturadas e atraentes para iniciantes e especialistas. Mais especificamente, o objetivo é reorganizar a documentação existente em novas seções e criar um novo tutorial de início para iniciantes que amplie o tutorial Flux 60-mine-blitz.
O projeto consiste nas seguintes fases:
Analise o site de documentação atual: audite as informações existentes e defina um guia de estilo (para as informações) para criar novos tutoriais.
Definir uma nova estrutura para as informações e o tutorial de início: trabalhe com os mentores para determinar as novas seções e reorganizar o site de documentação. Além disso, defina um sumário para o tutorial de início usando o tutorial Flux 60-mine-blitz como ponto de partida e desenvolva a partir dele.
Reestruturar as informações: atualizar o site com o plano definido em colaboração com os mentores na etapa anterior.
Criar o tutorial de iniciação: escreva e revise o primeiro rascunho. Receber feedback dos mentores. Quando os mentores e eu determinarmos que temos uma versão final deste documento, vou publicá-la no site de documentação.
(Opcional) Converter a documentação existente em forma de README para HTML: se eu tiver algum tempo restante depois de concluir as quatro fases principais, posso converter os tutoriais existentes que são README para que sejam mais fáceis de acessar no site.
Para atingir a meta do projeto, trabalharei em estreita colaboração com a comunidade do Flux para entender a documentação existente e determinar a melhor abordagem. Eu também sou iniciante em Julia e acredito que isso vai ajudar muito a determinar o nível certo de informações para o novo tutorial de início.
Vou me concentrar em garantir que meu trabalho ajude a comunidade do Flux a integrar novos usuários. Além disso, vou me concentrar em ajudar usuários experientes a descobrir novos casos de uso e explorar os detalhes mais sutis do Flux.