Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Le langage julia
- Rédacteur technique:
- sophisti
- Nom du projet:
- Réinventer le site Web FluxML
- Durée du projet:
- Durée standard (3 mois)
Project description
Cette proposition vise à améliorer le site Web de documentation de Flux afin que les informations qu'il contient soient structurées et attrayantes pour les nouveaux arrivants et les experts. L'objectif est plus précisément de réorganiser la documentation existante dans de nouvelles sections et de créer un tutoriel de démarrage destiné aux débutants, qui étend le tutoriel Flux 60-mine-blitz.
Le projet comprend les phases suivantes:
Analyser le site Web de documentation actuel: auditez les informations existantes et définissez un guide de style (pour les informations) pour la création de nouveaux didacticiels.
Définir une nouvelle structure pour les informations et le tutoriel de démarrage: Travaillez avec les mentors pour déterminer les nouvelles sections et la réorganisation du site Web de documentation. Définissez également une table des matières pour le tutoriel de démarrage en utilisant le tutoriel Flux 60-mine-blitz comme point de départ et poursuivez-la.
Restructurez les informations: mettez à jour le site Web avec le plan défini en collaboration avec les mentors à l'étape précédente.
Créez le tutoriel de mise en route: rédigez la première ébauche et révisez-la. Obtenir les commentaires des mentors. Lorsque les mentors et moi déterminons que nous disposons d'une version finale de ce document, je la publierai ensuite sur le site Web de la documentation.
(Facultatif) Convertissez la documentation existante sous forme de fichiers README en HTML: s'il me reste un peu de temps après avoir terminé les quatre phases principales, je peux convertir les didacticiels existants en fichiers README afin qu'ils soient plus faciles d'accès sur le site Web.
Pour atteindre l'objectif du projet, je travaillerai en étroite collaboration avec la communauté Flux afin de comprendre la documentation existante et de déterminer la meilleure approche. Je débute avec Julia et je pense que cela sera très utile pour déterminer le bon niveau d'information pour le nouveau tutoriel de démarrage.
Je vais m'assurer que mon travail aide la communauté Flux à intégrer de nouvelles utilisations. Mon but également : aider les utilisateurs expérimentés à découvrir de nouveaux cas d'utilisation et explorer plus en détail Flux.