Diese Seite enthält die Details eines Projekts für technische Dokumentation, das für Google Season of Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- GDevelop
- Technischer Redakteur:
- David Turnbull
- Projektname:
- Die optimale Lernerfahrung für Anfänger gestalten
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Schritt 1: Content-Audit durchführen
Dazu müssen Sie sich intensiv mit der vorhandenen Dokumentation auseinandersetzen und ein umfassendes Verständnis davon entwickeln, wie GDevelop funktioniert und was neue Nutzer am meisten daran faszinieren könnte. I'll also follow the existing tutorials and note down any stumbling blocks I face.
Schritt 2: Leitfaden „Erste Schritte“ umschreiben
Wenn ein Nutzer die GDevelop-Dokumentation liest, ist seine erste Anlaufstelle wahrscheinlich der Leitfaden „Erste Schritte“. Der Leitfaden selbst ist jedoch nicht besonders spannend – er behandelt nur die Installation von GDevelop, das Öffnen eines Projekts usw. Ich möchte diesen Leitfaden umschreiben, damit Nutzer etwas erreichen, auch wenn dieses „Etwas“ klein ist (z. B. das Hinzufügen eines Objekts zu einem Spiel). Ich möchte auch die nächsten Schritte klarer darstellen, da der aktuelle Leitfaden am Ende viele Links enthält, was Nutzer mit der Qual der Wahl überfordern könnte.
Schritt 3: Informationsarchitektur verbessern
Die GDevelop-Dokumentation enthält einige großartige Inhalte – insbesondere die Tutorials sind wirklich gut –, aber diese Inhalte werden nicht unbedingt optimal präsentiert. Anhand der Erkenntnisse aus dem Content-Audit möchte ich untersuchen, wie die Inhalte und die Navigation neu organisiert werden können, damit Nutzer die benötigten Inhalte finden, wenn sie sie brauchen.
Im Laufe des Projekts werden sich sicherlich weitere Aufgaben/Möglichkeiten ergeben – wenn ich erst einmal mit einem Dokumentationsprojekt beginne, kann ich mich dem nicht entziehen –, aber ich denke, dass diese Schritte eine solide Grundlage bilden.