Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Infraestructura del compilador de LLVM
- Escritor técnico:
- DR87
- Nombre del proyecto:
- Reestructura el índice de documentación de LLVM y la guía de estilo de la documentación
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Este proyecto incluye las siguientes tareas:
a.) Reestructura la página de índice de documentación para brindar una experiencia más fácil de usar. Esta tarea consistirá en evaluar la página actual y reestructurarla en función de una combinación de investigación independiente, entrevistas a los SME y comentarios de los usuarios. Las opciones posibles incluyen revisar las descripciones breves, reestructurar la página existente o agregar capas adicionales (páginas) a través de un modelo progresivo de divulgación de información. Este último reduciría el número de vínculos en la página de índice principal para que a los usuarios les resulte más fácil encontrar información/guías específicas. Por ejemplo, el índice puede incluir vínculos a páginas diferentes de Diseño y descripción general de LLVM, Guías de usuario, Documentación del subsistema y Documentación del proceso de desarrollo.
b.) Se actualizó la guía de estilo de LLVM Sphinx para colaboradores de código abierto. Esta tarea incluirá evaluar la guía actual, identificar las brechas a través de investigaciones independientes y entrevistas a SME, y actualizar la guía en función de los requisitos acordados. Por ejemplo, puedes reorganizar el diseño de la guía, agregar contenido nuevo y agregar vínculos a páginas relevantes, como la guía para colaboradores. El objetivo final es facilitar que los voluntarios comiencen a contribuir lo antes posible.