En esta página, se incluyen 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
- Redactor técnico:
- sophb
- Nombre del proyecto:
- Reinventamos el sitio web de FluxML
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
El objetivo de esta propuesta es mejorar el sitio web de documentación de Flux para que la información que contiene esté estructurada y sea atractiva para principiantes y expertos. Más concretamente, el objetivo es reorganizar la documentación existente en nuevas secciones y crear un nuevo tutorial para los principiantes que extiende 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 instructivos nuevos.
Define una nueva estructura para la información y el instructivo de introducción: Trabaja con los mentores para determinar las secciones nuevas y la reorganización del sitio web de documentación. Además, define un índice para el instructivo de introducción con el instructivo de Flux 60-mine-blitz como punto de partida y desarróllalo.
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 para comenzar: escribe el primer borrador y revísalo. Obtén comentarios de los mentores. Cuando los mentores y yo determinemos que tenemos una versión final de este documento, la publicaré en el sitio web de documentación.
(Opcional) Convierte la documentación existente en archivos README a HTML: si me queda algo de tiempo después de completar las cuatro fases principales, puedo convertir los tutoriales 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é en estrecha colaboración con la comunidad de Flux para comprender la documentación existente y determinar el mejor enfoque. Yo también soy un usuario nuevo de Julia y creo que esto será muy útil para determinar el nivel correcto de la información para el nuevo instructivo de introducción.
Me enfocaré en asegurarme de que mi trabajo ayude a la comunidad de Flux a incorporar nuevos usos. Además, me enfocaré en ayudar a los usuarios experimentados a descubrir nuevos casos de uso y explorar los detalles más finos de Flux.