Esta página contém os detalhes de um projeto de redação técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Infraestrutura do compilador LLVM
- Redator técnico:
- DR87
- Nome do projeto:
- Reestruturar o índice de documentação do LLVM e o guia de estilo da documentação
- 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. Essa 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 PMEs e feedback de usuários. As possíveis opções incluem revisar as descrições curtas, reestruturar a página existente e/ou adicionar outras camadas (páginas) por um modelo progressivo de divulgação de informações. O segundo método 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 sobre design e visão geral de LLVM, guias do usuário, documentação do subsistema e documentação do processo de desenvolvimento.
b.) Atualização do guia de estilo do 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 PMEs 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 novo conteúdo e a inserção de links para páginas relevantes, como o guia para colaboradores. O objetivo é facilitar a contribuição dos voluntários o mais rápido possível.