ScummVM-Projekt

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:
ScummVM
Technischer Redakteur:
Kader
Projektname:
Dokumentationsportal starten
Projektdauer:
Standarddauer (3 Monate)

Projektbeschreibung

Lernziele:

  • Um eine qualitativ hochwertige, versionierte Endnutzerdokumentation zu erstellen, indem große Mengen an Informationen aus unterschiedlichen Quellen konsolidiert und Informationen neu geschrieben werden, um Klarheit, Einheitlichkeit und Vollständigkeit zu gewährleisten.
  • Die Dokumentation sollte für Anfänger leicht verständlich sein, ohne vor technikaffinen Nutzern zu bevorzugen.
  • Erstellen eines Dokumentationsportals mit einem Generator für statische Websites
  • Mit Vorlagen und detaillierten Anleitungen für zukünftige Open-Source-Beitragende eine zukunftssichere Endnutzerdokumentation erstellen

Aktuelle Situation:

  • Die verfügbare ScummVM-Dokumentation ist auf mehrere Quellen verteilt.
  • Informationen sind schwer zu finden und oft doppelt vorhanden. Auf unübersichtlichen Seiten kann es leicht passieren, dass sie verloren gehen.
  • Oft lässt sich nur schwer herausfinden, welche Informationen aktuell sind und welche veraltet sind.
  • Einige Informationen fehlen oder sind unvollständig.

So beheben Sie das Problem:

Vorgeschlagene Dokumentationsstruktur:

Landingpage |-- Erste Schritte | -- Quick start guide |-- Installing ScummVM | |-- Nintendo 3DS | |-- AmigaOS | |-- Android | |-- (every) | |-- (common) | |-- (supported) |-- (Plattform) |-- ScummVM verwenden | |-- Der Launcher | |-- Globale Einstellungen | |-- Spieleinstellungen | -- Keyboard shortcuts |-- Advanced options | |-- Cloud and LAN | |-- Control Mapping | |-- Configuration | |-- Command line options | |-- Graphics |-- Musik und Ton |-- Hilfe | |-- FAQ | |-- Kontakte | |-- Bekannte Probleme | -- Reporting a bug |-- Game Notes-- Versionshinweise

  • Erste Schritte:

Neue Nutzer wünschen sich oft eine Kurzanleitung, um so schnell wie möglich loslegen zu können. Die Installation von ScummVM kann auf einigen Plattformen komplex sein, auf einem Computer jedoch nicht.

In der Kurzanleitung sollte Folgendes beschrieben werden:

  • Installation von ScummVM auf Windows, Mac und Linux

  • Informationen zum Laden, Hinzufügen und Starten eines Spiels.

  • Installieren von ScummVM:

Falls die Installation nicht intuitiv erfolgt oder der Nutzer keine solide technische Basis hat, benötigt der Nutzer eine umfassende Anleitung zur Installation von ScummVM auf einer der unterstützten Plattformen.

Jede umfassende Installationsseite sollte Folgendes abdecken:

  • Systemanforderungen/-voraussetzungen
  • So laden Sie die entsprechende Version von ScummVM herunter.
  • So installieren Sie ScummVM
  • Wie Spiele auf die gewünschte Plattform geladen werden, insbesondere wenn sie nicht die Plattform ist, für die das Spiel entwickelt wurde.

  • Hier erfahren Sie, wie Sie ScummVM starten, ein Spiel hinzufügen und ein Spiel starten.

  • Mit ScummVM:

Nutzer benötigen Referenzdokumente, in denen die Verwendung von ScummVM erklärt wird.

Die Referenzdokumente sollten folgende Punkte abdecken:

  • Die Launcher-Benutzeroberfläche; Darstellung der einzelnen Fenster und Tabs sowie deren Funktionsweise
  • Erläuterung der verfügbaren globalen und spielspezifischen Einstellungen

  • Tastenkombinationen/Hotkeys.

  • Erweiterte Optionen:

Fortgeschrittene Nutzer benötigen zusätzliche technische Informationen zu den Optionen, mit denen sie die Ausführung ihrer Spiele optimieren können.

  • Spielhinweise:

Alle spielspezifischen Informationen, die der Nutzer kennen muss, einschließlich, aber nicht beschränkt auf: - Installationshinweise - Alle zusätzlichen Dateien erforderlich - Ungewöhnliche oder abweichende Steuerungen

  • Bekannte Probleme:

In diesem Abschnitt sollten alle bekannten Fehler im Zusammenhang mit dieser Version aufgeführt sein.

  • Versionshinweise:

Unsere Dokumentation wird zwar versioniert sein, aber ein Abschnitt mit den Versionshinweisen kann hilfreich sein, um eine Zusammenfassung der Änderungen in der neuesten Version zu bieten. Dies kann auch Bereiche betreffen, die derzeit nicht im Umfang dieser Dokumentation behandelt werden, wie z. B. neue unterstützte Spiele oder Informationen zu neuen Engines.

Angriffsplan:

Ich schlage vor, mit der Erstellung einer Vorlage für die Seiten zum Installieren von ScummVM zu beginnen, da dies der einfachste Weg für mich ist, die benötigten Informationen von Port-Betreuern/Entwicklern zu erhalten (insbesondere, wenn diese Informationen nur wenige Informationen haben oder nicht vorhanden sind). Ich werde alle Informationen, die ich bereits aus einer vorhandenen Dokumentation habe, vorab ausfüllen und diese dann auf Vollständigkeit, Richtigkeit und Aktualität überprüfen oder bei Bedarf ergänzen.

Als Nächstes durchsuche ich die vorhandene Dokumentation (Readme, Wiki und Website). Im weiteren Verlauf werde ich die einzelnen Abschnitte nach Bedarf umschreiben und ergänzen und alle Informationen in das neue Portal übernehmen. Ich werde auch notieren, welche Informationen von wo abgerufen werden, um sicherzustellen, dass es, sobald das Portal online ist, keine Doppelungen, Widersprüche oder anderen Anomalien gibt.

Dabei werde ich mich mit den Mentor(en), Entwicklern, Portierungsverantwortlichen und anderen Fachleuten zusammensetzen, um fehlende Informationen zu finden und dafür zu sorgen, dass jede Seite so aktuell und umfassend wie möglich ist.

Im Sinne der Zusammenarbeit und vorbehaltlich der Zustimmung des/der Mentor(en) möchte ich der ScummVM-Community während des gesamten Schreibprozesses Zugang zum Work-in-Progress-Portal zur Verfügung stellen, um Feedback in Echtzeit zu erhalten und sicherzustellen, dass nichts übersehen wird.

Ich schlage vor, die Verwendung eines Styleguides wie z. B. des Styleguides der Google-Entwicklerdokumentation zu gewährleisten, um Einheitlichkeit für diesen Arbeitsablauf und die künftige Dokumentation zu gewährleisten.

Wenn möglich, verwende ich Screenshots, GIFs und andere visuelle Hilfsmittel, um das Verständnis zu verbessern.

Vorgeschlagener Zeitplan:

Community bonding 17. August bis 13. September 2020

Sprechen Sie weiterhin mit den Mentoren und der breiteren ScummVM-Community, um die Vision für das Projekt zu optimieren und Details wie die Dokumentstruktur und den Inhalt festzulegen.

Woche 1 14. September–20. September

  • Erstellen Sie eine Vorlage für die plattformspezifischen Installationsseiten.
  • Füllen Sie die Vorlagen vorab mit den vorhandenen Informationen aus und geben Sie sie an die entsprechenden Personen mit der Rolle „Port Manager“/„Entwickler“ weiter, um weitere Informationen zu erhalten.

Woche 2 21. September–27. September

  • Richten Sie das neue Dokumentationsportal ein.

Woche 3 28. September bis 4. Oktober

Mit ScummVM: – Die Benutzeroberfläche – Globale Einstellungen ScummVM installieren: – Plattformspezifische Installationsanleitungen als ausgefüllte Vorlagen werden an mich zurückgesendet.

Woche 4 5. Oktober bis 11. Oktober

Mit ScummVM: - Spieleinstellungen - Tastaturkürzel ScummVM installieren: - Plattformspezifische Installationsanleitungen, da vollständige Vorlagen an mich zurückgesendet werden

Woche 5 12. Oktober bis 18. Oktober

Erweiterte Optionen: - Cloud und LAN - Steuerungszuordnung - ScummVM installieren: - Plattformspezifische Installationsanleitungen, da vollständige Vorlagen an mich zurückgesendet werden

Woche 6 19. Oktober bis 25. Oktober

Erweiterte Optionen: – Konfiguration – Befehlszeilenoptionen ScummVM installieren: – Plattformspezifische Installationsanleitungen, da mir die ausgefüllten Vorlagen zurückgeschickt werden

Woche 7 26. Oktober bis 1. November

Erweiterte Optionen: – Grafiken – Audio ScummVM installieren: – Plattformspezifische Installationsanleitungen, da mir die ausgefüllten Vorlagen zurückgeschickt werden

Woche 8 2. November bis 8. November

Hilfe: - Häufig gestellte Fragen - Kontakte - Bekannte Probleme

Installieren von ScummVM: - Plattformspezifische Installationsanleitungen, da vollständige Vorlagen an mich zurückgesendet werden

Woche 9 9. November bis 15. November

Hilfe: – Fehler melden – Spielhinweise – Versionshinweise

ScummVM installieren: – Alle noch nicht abgeschlossenen Plattformleitfäden fertigstellen.

Woche 10 16. November bis 22. November

  • Abschließende Bearbeitung, Korrektur und Fertigstellung aller portalbezogenen Entscheidungen, z. B. Navigation in der Seitenleiste, Design/CSS-Anpassungen usw.
  • Prüfen Sie, ob alle Links wie erwartet funktionieren.
  • Prüfen Sie, ob Bilder/GIFs korrekt angezeigt werden.

Woche 11 23. November bis 30. November

  • Schließe alle ausstehenden Elemente ab und starte das Portal offiziell!
  • Nach dem Start des Portals entfernen Sie in Absprache mit den beratenden Personen redundante Informationen aus anderen Quellen.