ScummVM-Projekt

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:
ScummVM
Technischer Redakteur:
Cadi
Projektname:
Dokumentationsportal starten
Projektlänge:
Standardlänge (3 Monate)

Projektbeschreibung

Lernziele:

  • Erstellen hochwertiger, versionierter Dokumentationen für Endnutzer, indem große Mengen an Informationen aus verschiedenen Quellen zusammengeführt und die Informationen zugunsten von Klarheit, Konsistenz und Vollständigkeit umgeschrieben werden.
  • Die Dokumentation sollte für Anfänger leicht verständlich sein, ohne technisch versierte Nutzer zu bevormunden.
  • Mit einem Generator für statische Websites ein Dokumentationsportal erstellen
  • Die Dokumentation für Endnutzer zukunftssicher machen, indem Vorlagen und detaillierte Anleitungen für zukünftige Open-Source-Mitarbeiter erstellt werden.

Aktuelle Situation:

  • Die verfügbare ScummVM-Dokumentation ist auf mehrere Quellen verteilt.
  • Informationen sind schwer zu finden und werden oft dupliziert. Auf unklaren Seiten kann es leicht passieren, dass sie verloren gehen.
  • Es ist schwer zu wissen, welche Informationen aktuell und welche veraltet sind.
  • Einige Informationen fehlen oder sind unvollständig.

So beheben Sie das Problem:

Empfohlene Struktur der Dokumentation:

Startseite |-- 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 | |-- FAQs | |-- Kontakt | |-- Bekannte Probleme | -- Reporting a bug |-- Game Notes-- Release Notes

  • Erste Schritte:

Neue Nutzer suchen oft nach einer Kurzanleitung, um so schnell wie möglich loszulegen. Während die Installation von ScummVM auf einigen Plattformen komplex sein kann, ist die Installation auf einem Computer nicht der Fall.

Die Kurzanleitung sollte Folgendes enthalten:

  • So installieren Sie ScummVM unter Windows, Mac und Linux.

  • So laden, fügen und starten Sie ein Spiel.

  • ScummVM installieren:

Wenn die Installation nicht intuitiv ist oder der Nutzer nicht über ausreichende technische Kenntnisse verfügt, benötigt er eine umfassende Anleitung zur Installation von ScummVM auf einer der unterstützten Plattformen.

Jede umfassende Installationsseite sollte Folgendes enthalten:

  • Alle Systemanforderungen/Voraussetzungen.
  • So laden Sie die richtige Version von ScummVM herunter.
  • ScummVM installieren
  • Wie Spiele auf der gewählten Plattform geladen werden, insbesondere wenn es sich dabei nicht um die Plattform handelt, für die das Spiel entwickelt wurde.

  • So starten Sie ScummVM, fügen ein Spiel hinzu und starten ein Spiel.

  • So verwenden Sie ScummVM:

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

Die Referenzdokumente sollten Folgendes abdecken:

  • Die Launcher-Oberfläche, das Aussehen und die Funktionsweise der einzelnen Fenster und Tabs.
  • Eine Erläuterung der verfügbaren globalen und spielspezifischen Einstellungen.

  • Tastenkombinationen/Hotkeys.

  • Erweiterte Optionen:

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

  • Spielnotizen:

Alle spielspezifischen Informationen, die ein Nutzer wissen muss, einschließlich, aber nicht beschränkt auf: - Besonderheiten bei der Installation - Erforderliche zusätzliche Dateien - Ungewöhnliche oder unterschiedliche Steuerelemente

  • Bekannte Probleme:

Dieser Abschnitt sollte alle bekannten Fehler enthalten, die spezifisch für die Version sind.

  • Versionshinweise:

Auch wenn unsere Dokumentation versioniert ist, kann ein Abschnitt mit den Versionshinweisen hilfreich sein, um eine Zusammenfassung der Änderungen in der neuesten Version bereitzustellen. Dies kann auch Bereiche umfassen, die derzeit nicht in dieser Dokumentation behandelt werden, z. B. neu unterstützte Spiele oder Informationen zu neuen Engines.

Angriffsplan:

Ich empfehle, als Erstes eine Vorlage für die Seiten zum Installieren von ScummVM zu erstellen, da dies der einfachste Weg für mich ist, die Informationen, die ich von Portbetreuern/Entwicklern benötige, zu erhalten (vor allem, wenn diese Informationen spärlich oder gar nicht vorhanden sind). Ich werde alle Informationen, die ich bereits aus vorhandenen Dokumenten habe, vorab ausfüllen. Diese können dann auf Vollständigkeit, Richtigkeit und Aktualität geprüft oder bei Bedarf ergänzt werden.

Als Nächstes werde ich die vorhandene Dokumentation durchgehen: README, Wiki und Website. Ich werde die einzelnen Abschnitte nach und nach überarbeiten und nach Bedarf ergänzen und alle Informationen in das neue Portal übertragen. Außerdem werde ich notieren, welche Informationen von wo abgerufen werden, damit es nach der Veröffentlichung des Portals keine doppelten Einträge, Widersprüche oder andere Anomalien gibt.

Dabei stehe ich in ständigem Austausch mit den Mentoren, Entwicklern, Port-Verantwortlichen und anderen Fachleuten, um fehlende Informationen zu beschaffen 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 Mentors möchte ich der ScummVM-Community während des gesamten Schreibprozesses das in Arbeit befindliche Portal zur Verfügung stellen, um Echtzeit-Feedback zu erhalten und sicherzustellen, dass nichts übersehen wird.

Ich empfehle, einen Styleguide wie den Styleguide für die Google Developers-Dokumentation zu verwenden, um für Einheitlichkeit bei diesem Arbeitsbestand und für alle zukünftigen Dokumentationen zu sorgen.

Nach Möglichkeit verwende ich Screenshots, GIFs und andere visuelle Hilfsmittel, um das Verständnis zu verbessern.

Vorgeschlagener Zeitplan:

Bindung der Community 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 verfeinern und Details wie die Dokumentstruktur und den Inhalt zu finalisieren.

Woche 1 14. bis 20. September

  • Erstellen Sie eine Vorlage für die plattformspezifischen Installationsseiten.
  • Füllen Sie die Vorlagen vorab mit vorhandenen Informationen aus und senden Sie sie an die entsprechenden Port-Betreuer/Entwickler, um weitere Informationen zu erhalten.

Woche 2 21. bis 27. September

  • Richten Sie das neue Dokumentationsportal ein.

Woche 3 28. September bis 4. Oktober

Mit ScummVM: – Die Benutzeroberfläche – Globale Einstellungen Installation von ScummVM: – Plattformspezifische Installationsanleitungen als fertige Vorlagen werden mir zurückgegeben.

Woche 4 5. Oktober bis 11. Oktober

Mit ScummVM: - Spieleinstellungen - Tastenkombinationen Installation von ScummVM: - Plattformspezifische Installationsanleitungen, da mir fertige Vorlagen zurückgegeben werden

Woche 5 12. Oktober bis 18. Oktober

Erweiterte Optionen: – Cloud und LAN – Control Mapping ScummVM installieren: – Plattformspezifische Installationsanleitungen, da mir fertige Vorlagen zurückgegeben werden

Woche 6 19. Oktober bis 25. Oktober

Erweiterte Optionen: - Konfiguration - Befehlszeilenoptionen ScummVM installieren: - Plattformspezifische Installationsanleitungen, die mir als fertige Vorlagen zurückgesendet werden

Woche 7 26. Oktober bis 1. November

Erweiterte Optionen: – Grafik – Audio Installation von ScummVM: – Plattformspezifische Installationsanleitungen, da mir die fertigen Vorlagen zugesendet werden

Woche 8 2. November bis 8. November

Hilfe: - FAQ - Kontakte - Bekannte Probleme

ScummVM installieren: – Plattformspezifische Installationsanleitungen als fertige Vorlagen werden an mich zurückgesendet

Woche 9 9. November bis 15. November

Hilfe: - Fehler melden - Spielnotizen - Versionshinweise

ScummVM installieren: – Schließe alle noch nicht abgeschlossenen Plattformanleitungen ab.

Woche 10 16. November bis 22. November

  • Endgültiges Bearbeiten, Korrekturlesen und Fertigstellen aller portalbezogenen Entscheidungen wie Seitenleistennavigation, 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ßen Sie alle ausstehenden Punkte ab und starten Sie das Portal offiziell.
  • Entfernen Sie nach der Einführung des Portals in Absprache mit den Mentoren redundante Informationen aus anderen Quellen.