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:
- El lenguaje Julia
- Escritor técnico:
- sofía
- Nombre del proyecto:
- Reinventa el sitio web de FluxML
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
El objetivo de la propuesta es mejorar el sitio web de documentación de Flux para que la información que contiene sea estructurada y atractiva para principiantes y expertos. Específicamente, el objetivo es reorganizar la documentación existente en secciones nuevas y crear un nuevo tutorial de introducción para novatos que extienda el tutorial de Flux 60-mine-blitz.
El proyecto consta de las siguientes fases:
Analiza el sitio web de documentación actual: Audita la información existente y define una guía de estilo (para la información) para crear nuevos instructivos.
Definir una nueva estructura para la información y el tutorial de inicio: Trabaja con los mentores para determinar las nuevas secciones y la reorganización del sitio web de documentación. Además, define un índice para el tutorial de introducción usando el tutorial de Flux 60-mine-blitz como punto de partida y construye sobre él.
Reestructura la información: Actualiza el sitio web con el plan definido en colaboración con los mentores en el paso anterior.
Crea el instructivo de introducción: Escribe el primer borrador y revísalo. Obtener comentarios de los mentores Cuando los mentores y yo determinemos que tenemos una versión final de este documento, lo publicaré en el sitio web de documentación.
(Opcional) Convierte la documentación existente en formato de archivos README a HTML: si me queda tiempo después de completar las cuatro fases principales, puedo convertir los instructivos existentes que son archivos README para que sea más fácil acceder a ellos desde el sitio web.
Para lograr el objetivo del proyecto, trabajaré muy de cerca con la comunidad de Flux para comprender la documentación existente y determinar el mejor enfoque. Recién comienzo a usar Julia y creo que esto me ayudará a determinar el nivel correcto de información para el nuevo tutorial de introducción.
Me centraré en asegurarme de que mi trabajo ayude a la comunidad de Flux a incorporar nuevos usos. Además, me centraré en ayudar a los usuarios experimentados a descubrir nuevos casos de uso y a explorar los detalles más específicos de Flux.