Cette page contient les détails d'un projet de rédaction technique accepté pour la saison des documents Google.
Résumé du projet
- Organisation Open Source:
- La langue Julia
- Rédacteur technique:
- sophb
- Nom du projet:
- Repenser le site Web de FluxML
- Durée du projet:
- Durée standard (trois 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 débutants et les experts. Plus précisément, l'objectif est de réorganiser la documentation existante dans de nouvelles sections et de créer un nouveau tutoriel de démarrage destiné aux débutants, qui complétera le tutoriel Flux 60-mine-blitz.
Le projet se compose des phases suivantes:
Analyser le site Web actuel de la documentation: auditez les informations existantes et définissez un guide de style (pour les informations) pour créer de nouveaux tutoriels.
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 un sommaire pour le tutoriel de démarrage en vous appuyant sur le tutoriel Flux 60-mine-blitz.
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 démarrage: rédigez votre première ébauche et corrigez-la. Obtenir des commentaires des mentors. Lorsque les mentors et moi-même aurons déterminé que nous disposons d'une version finale de ce document, je le publierai sur le site Web de documentation.
(Facultatif) Convertir la documentation existante au format README en HTML: si j'ai encore du temps après avoir terminé les quatre phases principales, je peux convertir les tutoriels existants au format README afin qu'ils soient plus facilement accessibles depuis le site Web.
Pour atteindre l'objectif du projet, je vais travailler en étroite collaboration avec la communauté Flux afin de comprendre la documentation existante et de déterminer la meilleure approche. Je viens de découvrir Julia et je pense que ces informations pourront être très utiles pour déterminer le niveau d'informations approprié pour le nouveau tutoriel de démarrage.
Je vais m'assurer que mon travail aide la communauté Flux à intégrer de nouveaux utilisateurs. Je vais également m'attacher à aider les utilisateurs expérimentés à découvrir de nouveaux cas d'utilisation et à explorer les détails de Flux.