ScummVM-Projekt

Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:
ScummVM
Technischer Redakteur:
Kader
Projektname:
Dokumentationsportal öffnen
Projektdauer:
Standarddauer (3 Monate)

Projektbeschreibung

Lernziele:

  • Um eine 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 Einsteiger leicht verständlich sein, ohne vor technikaffinen Nutzern zu bevorzugen.
  • Sie erstellen ein Dokumentationsportal mit einem Static-Site-Generator.
  • Um die Endnutzerdokumentation zukunftssicher zu machen, indem Sie Vorlagen und detaillierte Anleitungen für zukünftige Open-Source-Mitwirkende erstellen

Die aktuelle Situation:

  • Die verfügbare ScummVM-Dokumentation ist auf mehrere Quellen verteilt.
  • Informationen sind schwer zu finden und oft dupliziert; auf dunklen Seiten kann man leicht verloren gehen.
  • Schwer zu sagen, welche Informationen aktuell und welche veraltet sind.
  • Einige Informationen fehlen oder sind unvollständig.

Problembehebung:

Vorgeschlagene Dokumentationsstruktur:

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

  • Erste Schritte:

Neue Nutzer suchen oft nach einer 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.

Die Kurzanleitung sollte Folgendes abdecken:

  • Installation von ScummVM unter Windows, Mac und Linux

  • Anleitung zum Laden, Hinzufügen und Starten eines Spiels

  • ScummVM wird installiert:

Falls die Installation nicht intuitiv ist oder der Nutzer keine starke technische Basis hat, benötigt der Nutzer ein umfassendes Handbuch zur Installation von ScummVM auf einer der unterstützten Plattformen.

Jede umfassende Installationsseite sollte Folgendes umfassen:

  • Systemanforderungen/Voraussetzungen
  • Hier erfahren Sie, wie Sie die entsprechende Version von ScummVM herunterladen.
  • Installieren von ScummVM
  • Wie Spiele auf die gewählte Plattform geladen werden, insbesondere wenn es nicht die Plattform ist, für die das Spiel entwickelt wurde.

  • Starten von ScummVM sowie Hinzufügen und Starten eines Spiels

  • Mit ScummVM:

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

Die Referenzdokumente sollten Folgendes abdecken:

  • Die Launcher-Benutzeroberfläche; Darstellung der einzelnen Fenster und Tabs sowie deren Funktionsweise
  • Erläuterung der verfügbaren Einstellungen, sowohl global als auch spielspezifisch

  • Tastenkombinationen/Hotkeys.

  • Erweiterte Optionen:

Fortgeschrittene Nutzer benötigen zusätzliche, detailliertere Informationen zu den Optionen, mit denen sie den Spielverlauf optimieren können.

  • Spielnotizen:

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

  • Bekannte Probleme:

Dieser Abschnitt sollte alle bekannten Programmfehler enthalten, die speziell für die Version bekannt sind.

  • Versionshinweise:

Während unsere Dokumentation versioniert wird, kann ein Abschnitt mit den Versionshinweisen hilfreich sein, um eine Zusammenfassung der Änderungen in der neuesten Version zu bieten. Dazu gehören unter Umständen Bereiche, die derzeit nicht im Rahmen dieser Dokumentation abgedeckt sind, z. B. neu 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 die einfachste Möglichkeit für mich ist, die erforderlichen Informationen von Port-Betreuern/Entwicklern zu erhalten (insbesondere, wenn diese Informationen nur wenige Informationen enthalten oder nicht vorhanden sind). Ich werde alle Informationen, die mir bereits aus vorhandenen Dokumenten zur Verfügung stehen, vorab ausfüllen. Diese können dann auf Vollständigkeit, Genauigkeit und Währung geprüft oder bei Bedarf ergänzt werden.

Als Nächstes durchsuche ich die vorhandene Dokumentation: Readme, Wiki und Website. Jetzt schreibe ich die einzelnen Abschnitte neu und füge sie bei Bedarf hinzu. Alle Informationen werden dann in das neue Portal übernommen. Ich werde auch notieren, welche Informationen von wo abgerufen werden, um sicherzustellen, dass das Portal online ist und es keine Doppelungen, Widersprüche oder anderen Anomalien gibt.

Dabei werde ich mit den Mentoren, Entwicklern, Personen, die das Porträt verwalten, und anderen Fachleuten zusammenarbeiten, 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 Mentors bzw. der Mentoren 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, einen Styleguide wie den Styleguide für die Google-Entwicklerdokumentation zu verwenden, um sicherzustellen, dass dieser Arbeitsumfang und die gesamte Dokumentation auch zukünftig einheitlich sind.

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

Nehmen Sie sich weiter Zeit mit dem Mentor bzw. den Mentoren und der breiteren ScummVM-Community, um die Vision für das Projekt zu optimieren und Details wie Dokumentstruktur und -inhalt festzulegen.

Woche 1 14. September–20. September

  • Erstelle eine Vorlage für die plattformspezifischen Installationsseiten.
  • Füllen Sie die Vorlagen vorab mit vorhandenen Informationen aus und leiten Sie sie an die zuständigen 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 Schnittstelle – Globale Einstellungen ScummVM installieren: – Plattformspezifische Installationsanleitungen, da vollständige Vorlagen an mich zurückgesendet werden

Woche 4 5. Oktober–11. Oktober

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

Woche 5 12. Oktober–18. Oktober

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

Woche 6 19. Oktober–25. Oktober

Erweiterte Optionen: - Konfiguration - Befehlszeilenoptionen ScummVM installieren: - Plattformspezifische Installationsanleitungen, da vollständige Vorlagen an mich zurückgesendet werden

Woche 7 26. Oktober–1. November

Erweiterte Optionen: - Grafik - Audio ScummVM installieren: - Plattformspezifische Installationsanleitungen, da vollständige Vorlagen an mich zurückgesendet werden

Woche 8 2. November–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–15. November

Hilfe: - Fehler melden - Spielhinweise - Versionshinweise

ScummVM installieren: – alle noch nicht abgeschlossenen Plattformleitfäden fertigstellen

Woche 10 16. November–22. November

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

Woche 11 23. November–30. November

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