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:
- Infraestrutura do compilador do LLVM
- Redator técnico:
- DR87
- Nome do projeto:
- Reestruturar o índice e o guia de estilo da documentação do LLVM
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Este projeto inclui as seguintes tarefas:
a.) Reestruture a página de índice da documentação para oferecer uma experiência mais fácil de usar. Esta tarefa envolverá a avaliação da página atual e a reestruturação dela com base em uma combinação de pesquisas independentes, entrevistas com especialistas e feedback de usuários. As opções possíveis incluem revisar as descrições breves, reestruturar a página existente e/ou adicionar outras camadas (páginas) por um modelo progressivo de divulgação de informações. Essa última opção reduziria o número de links na página de índice principal para facilitar a localização de informações/guias específicos pelos usuários. Por exemplo, o índice pode incluir links para páginas separadas de Design e visão geral do LLVM, guias do usuário, documentação do subsistema e documentação do processo de desenvolvimento.
b.) Atualização do guia de estilo LLVM Sphinx para colaboradores de código aberto. Essa tarefa incluirá a avaliação do guia atual, a identificação de lacunas por meio de pesquisas independentes e entrevistas com especialistas, e a atualização do guia com base nos requisitos acordados. As atualizações podem incluir a reorganização do layout do guia, a adição de novos conteúdos e a inserção de links para páginas relevantes, como o guia do colaborador. O objetivo é facilitar a contribuição dos voluntários assim que possível.