Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Infraestructura de compiladores de LLVM
- Redactor técnico:
- DR87
- Nombre del proyecto:
- Reestructuración del índice de documentación y la guía de estilo de la documentación de LLVM
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Este proyecto incluye las siguientes tareas:
a.) Reestructura la página del índice de la documentación para brindar una experiencia más fácil de usar. Esta tarea implicará evaluar la página actual y reestructurarla en función de una combinación de investigación independiente, entrevistas con SME y comentarios de los usuarios. Entre las opciones posibles, se incluyen revisar las descripciones breves, reestructurar la página existente o agregar capas adicionales (páginas) a través de un modelo de divulgación de información progresiva. Estas últimas reducirían la cantidad de vínculos en la página de índice principal para facilitar a los usuarios la ubicación de información o guías específicas. Por ejemplo, el índice podría incluir vínculos a páginas separadas para Diseño y descripción general de LLVM, Guías del usuario, Documentación del subsistema y Documentación del proceso de desarrollo.
b.) Se actualizó la guía de estilo de la esfinge de LLVM 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 con SME, y actualizar la guía en función de los requisitos acordados. Las actualizaciones pueden incluir reorganizar el diseño de la guía, agregar contenido nuevo y, también, insertar 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.