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:
- LLVM Compiler Infrastructure
- 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 (três meses)
Project description
Esse projeto inclui as seguintes tarefas:
a.) Reestruturar a página de índice da documentação para oferecer uma experiência mais fácil de usar. Essa tarefa envolve 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 dos usuários. As opções possíveis incluem revisar as descrições curtas, reestruturar a página atual e/ou adicionar outras camadas (páginas) usando um modelo progressivo de divulgação de informações. A segunda 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 para Design e visão geral do LLVM, Guias do usuário, Documentação do subsistema e Documentação do processo de desenvolvimento.
b.) Atualizamos o 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 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 do colaborador. O objetivo final é facilitar a contribuição dos voluntários o mais rápido possível.