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:
- Open Collective
- Technischer Redakteur:
- Anna e só
- Projektname:
- Allgemeine Hilfedokumentation verbessern
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Der erste Eindruck Es kommt häufig vor, dass Dokumentationsseiten ohne unterstützende Medien (Videos, GIFs, Bilder) angezeigt werden, während andere Abschnitte desselben Kapitels vollständigere Einträge enthalten. Edit Collective besteht zum Beispiel nur aus Anweisungen, während Add Fiscal Host unterstützende Medien enthält.
Auf den Seiten, die ich durchstöbert habe, werden keine Medien mit dem Attribut „alt text“ beschrieben. Wenn Bildbeschreibungen fehlen, ist die Dokumentation sowohl für Personen mit Screenreadern als auch für Nutzer mit langsameren Internetverbindungen, bei denen Medien möglicherweise nicht geladen werden, erschwert.
In einigen Abschnitten der Dokumentation werden häufig gestellte Fragen zur Zusammenführung sowie direkte Anleitungen zur Navigation auf der Benutzeroberfläche zusammengeführt, z. B. Change Fiscal Host. Da es in der Dokumentationsoberfläche kein Inhaltsverzeichnis gibt, kann ein Benutzer, der sich der Folgen einer Änderung der Registrierungseinträge bewusst ist und nur objektive Anweisungen erhalten möchte, die Dokumentation als ausführlich und zu tangential empfinden.
Auch wenn die Sprache der technischen Dokumentation recht einheitlich ist, finden Sie im öffentlich verfügbaren Styleguide zu wenig Informationen darüber, wie die Dokumentation verfasst sein sollte. Da auf der Seite Beitragen Beiträge zur technischen Dokumentation erwähnt werden, profitieren sowohl Open Collective als auch potenzielle Beitragende von umfassenderen Richtlinien.
Vorschlag Ich schlage vor, die Hilfeseiten der Nutzenden zu überprüfen und die Präsentation und die aktuelle Struktur zu überdenken.
Methodik und Zeitplan Ich möchte die Open Collective-Dokumentation verbessern, indem ich mit der Community zusammenarbeite und Zyklen von kontinuierlichem Feedback mit unterschiedlicher Dauer vorantrete.
Community-Bonding-Zeitraum (1. August bis 1. September 2019): Die Open Collective-Community kennenlernen Sie befragen aktive Mitglieder aus bekannten und Startprojekten und stellen ihnen Fragen zum aktuellen Stand der Dokumentation (Bericht 1). Notieren Sie sich alle internen Systeme, die zur Verfolgung von Abfragen und Problemen verwendet werden, sowie den Prozess zu deren Dokumentation in Open Collective Docs (Bericht Nr. 2). Auswertung offener Probleme in der aktuellen Version der Dokumentation und Ausarbeitung eines Plans zu deren Lösung (Bericht 3).
2. bis 6. September: Erstes Feedback und Anpassungszyklus, unter Berücksichtigung aller Kommentare und Vorschläge der Community während der Bindungsphase der Community. Ist unser Plan gut? Gibt es etwas, das geändert werden muss? (Bericht 4)
9. bis 20. September: Entwicklung eines Proof of Concept mit dem weniger befüllten Kapitel der Dokumentation. Entwurf eines öffentlichen Styleguides (Bericht Nr. 5).
23. bis 25. September: Einreichung des Proof of Concept zur Bewertung (geschlossene Gruppe).
26. bis 27. September: Müssen an unserem Proof of Concept Anpassungen vorgenommen werden, bevor es veröffentlicht wird? Brauchen wir mehr Zeit? Passen Sie sie entsprechend an. (Bericht 6)
30. September bis 9. Oktober: Proof of Concept geht online. Zweiter Feedback-Zyklus (öffentliche Gruppe).
10. bis 15. Oktober: Abschließende Bewertung des Proof of Concept und Anpassungszyklus. (Bericht 7)
16.–20. Oktober: Kleine Pause von den Aktivitäten [1].
21. Oktober bis 23. November: Der öffentliche Styleguide ist endgültig (Bericht Nr. 8). Anwendung aller Anweisungen im Styleguide auf alle Seiten der Benutzerdokumentation (Bericht Nr. 9). Bericht mit der Bewertung aller durchgeführten Aktivitäten und weiterer Empfehlungen für die Community (Bericht 10).
Die Projektdauer kann auf Anfrage verlängert werden.
[1]: Reise, die vor meiner Bewerbung für die Saison der Google Docs geplant ist.
Ergebnisse - 10 öffentliche Berichte über die durchgeführten Aktivitäten - Ein öffentlicher Styleguide, den Open Collective und externe Mitwirkende verwenden können - Überarbeitete Nutzerdokumentationsseiten