Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Die Julia Language
- Technischer Redakteur:
- Sophb
- Projektname:
- Die FluxML-Website neu erfinden
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Mit diesem Vorschlag soll die Dokumentationswebsite von Flux verbessert werden, sodass die darin enthaltenen Informationen für Neueinsteiger und Experten attraktiv und strukturiert sind. Genauer gesagt besteht das Ziel darin, die vorhandene Dokumentation in neue Abschnitte zu gliedern und ein neues Tutorial für Einsteiger zu erstellen, das das Tutorial für Flux 60-Minenblitz-Videos erweitert.
Das Projekt besteht aus den folgenden Phasen:
Analysieren Sie die aktuelle Dokumentationswebsite: Prüfen Sie die vorhandenen Informationen und definieren Sie einen Styleguide (für die Informationen) zum Erstellen neuer Tutorials.
Definieren Sie eine neue Struktur für die Informationen und das Tutorial für die ersten Schritte: Legen Sie gemeinsam mit den beratenden Personen die neuen Abschnitte fest und strukturieren Sie die Dokumentationswebsite. Definieren Sie auch ein Inhaltsverzeichnis für das Tutorial mit der Flux 60-Mine-Blitz-Anleitung als Ausgangspunkt und bauen Sie darauf auf.
Informationen umstrukturieren: Aktualisieren Sie die Website mit dem Plan, der im vorherigen Schritt zusammen mit den beratenden Personen definiert wurde.
Tutorial für die ersten Schritte erstellen: Schreiben Sie den ersten Entwurf und sehen Sie sich ihn an. Feedback von den beratenden Personen einholen. Wenn die Mentoren und ich feststellen, dass wir eine endgültige Version dieses Dokuments haben, werde ich es auf der Dokumentationswebsite veröffentlichen.
(Optional) Konvertieren Sie die vorhandene Dokumentation in Form von Readmes in HTML: Wenn ich nach Abschluss der vier Hauptphasen noch etwas Zeit habe, kann ich die vorhandenen Tutorials mit Readme-Dateien konvertieren, damit von der Website aus leichter darauf zugegriffen werden kann.
Um das Projektziel 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 eine Neulinge von Julia und ich glaube, dass dies sehr hilfreich ist, um die richtigen Informationen für das neue Tutorial für die ersten Schritte zu ermitteln.
Ich werde mich darauf konzentrieren, dass meine Arbeit der Flux-Community bei der Einarbeitung neuer Anwendungen hilft. Außerdem werde ich erfahrene Nutzer dabei unterstützen, neue Anwendungsfälle zu entdecken und die Details von Flux zu erkunden.