Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Die Programmiersprache Julia
- Technischer Redakteur:
- sophb
- Projektname:
- Die FluxML-Website neu erfinden
- Projektlänge:
- Standardlänge (3 Monate)
Projektbeschreibung
Mit diesem Vorschlag soll die Dokumentationswebsite von Flux so verbessert werden, dass die darin enthaltenen Informationen für Einsteiger und Experten strukturiert und ansprechend sind. Konkret besteht das Ziel darin, die vorhandene Dokumentation in neue Abschnitte zu unterteilen und ein neues Einstiegsleitfaden für Neulinge zu erstellen, das das Flux-60-Minen-Blitz-Tutorial erweitert.
Das Projekt besteht aus den folgenden Phasen:
Analyse der aktuellen Dokumentationswebsite: Prüfen Sie die vorhandenen Informationen und definieren Sie einen Stilleitfaden (für die Informationen), um neue Anleitungen zu erstellen.
Eine neue Struktur für die Informationen und die Einführungsleitfaden definieren: Bestimmen Sie gemeinsam mit den Mentoren die neuen Abschnitte und die Neuorganisation der Dokumentationswebsite. Erstellen Sie außerdem ein Inhaltsverzeichnis für die Einführungsleitfaden. Verwenden Sie dazu das Flux-60-Minen-Blitz-Tutorial als Ausgangspunkt und bauen Sie darauf auf.
Informationen neu strukturieren: Aktualisieren Sie die Website mit dem Plan, den Sie im vorherigen Schritt in Zusammenarbeit mit den Mentoren festgelegt haben.
Erste Schritte-Anleitung erstellen: Verfassen Sie den ersten Entwurf und prüfen Sie ihn. Holen Sie sich Feedback von den Mentoren. Sobald die beratenden Personen und ich feststellen, dass wir eine endgültige Version dieses Dokuments haben, werde ich es auf der Dokumentationswebsite veröffentlichen.
Optional: Vorhandene Dokumentation in Form von READMEs in HTML konvertieren: Wenn nach Abschluss der vier Hauptphasen noch Zeit bleibt, kann ich die vorhandenen Anleitungen in READMEs konvertieren, damit sie über die Website leichter zugänglich sind.
Um das Ziel des Projekts zu erreichen, werde ich eng mit der Flux-Community zusammenarbeiten, um die vorhandene Dokumentation zu verstehen und den besten Ansatz zu ermitteln. Ich bin selbst noch ein Neuling in Julia und ich glaube, dass dies sehr hilfreich sein wird, um das richtige Niveau der Informationen für das neue Einstiegshandbuch zu bestimmen.
Ich werde mich darauf konzentrieren, dass meine Arbeit der Flux-Community dabei hilft, neue Nutzer zu gewinnen. Außerdem werde ich erfahrenen Nutzern helfen, neue Anwendungsfälle zu entdecken und die feinen Details von Flux zu erkunden.