Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Open Collective
- Technischer Redakteur:
- Anna e só
- Projektname:
- Allgemeine Hilfedokumentation verbessern
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Der erste Eindruck Es kommt häufig vor, dass auf Dokumentationsseiten ohne unterstützende Medien (Videos, GIFs, Bilder) stößt, während andere Abschnitte im selben Kapitel ausführlichere Einträge enthalten. So enthält Edit Collective beispielsweise nur Anleitungen, während Fiscal Host hinzufügen unterstützende Medien enthält.
Auf den Seiten, die ich mir angesehen habe, werden keine Medien mit dem Alt-Text-Attribut beschrieben. Ohne Bildbeschreibungen können Nutzer, die Screenreader verwenden, und Nutzer mit langsameren Internetverbindungen die Dokumentation nicht vollständig verstehen, da Medien möglicherweise nicht geladen werden.
In einigen Abschnitten der Dokumentation werden FAQs und direkte Anleitungen zur Navigation in der Benutzeroberfläche kombiniert, z. B. Fiskalhost ändern. Da es in der Dokumentationsoberfläche kein Inhaltsverzeichnis gibt, empfinden Nutzer, die sich der Folgen einer Änderung der Registrierungseinträge bewusst sind und nur objektive Anweisungen haben möchten, die Dokumentation möglicherweise als ausführlich und zu tangentiell empfinden.
Obwohl die Sprache der technischen Dokumentation ziemlich einheitlich ist, wird im öffentlich verfügbaren Stilhandbuch zu wenig darüber dokumentiert, wie die Dokumentation geschrieben werden sollte. Da auf der Seite Beitragende 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 für Nutzer zu überprüfen und ihre Präsentation und aktuelle Struktur zu überdenken.
Methodik und Zeitplan Ich möchte die Open Collective-Dokumentation verbessern, indem ich gemeinsam mit der Community Zyklen mit kontinuierlichem Feedback unterschiedlicher Dauer durchführe.
Kennenlernphase der Community (1. August bis 1. September 2019): Die Open Collective-Community kennenlernen Wir interviewen aktive Mitglieder von bekannten und startenden Projekten und stellen ihnen eine Frage zum aktuellen Stand der Dokumentation (Bericht Nr. 1). Notieren Sie sich alle internen Systeme, mit denen Anfragen und Probleme verfolgt werden, und den Prozess zur Dokumentation in den Open Collective-Dokumenten (Bericht 2). Bewertung latenter Probleme in der aktuellen Version der Dokumentation und Erstellen eines Plans zur Behebung dieser Probleme (Bericht 3).
2. bis 6. September: Erster Feedback- und Anpassungszyklus, bei dem alle Kommentare und Vorschläge berücksichtigt werden, die die Community während der Phase des Community-Aufbaus gepostet hat. Ist unser Plan in Ordnung? Muss etwas daran geändert werden? (Bericht 4)
9. bis 20. September: Entwicklung des Proof of Concepts mit dem weniger ausgefüllten Kapitel der Dokumentation. Entwurf eines öffentlichen Styleguides (Bericht 5).
23.–25. September: Einreichen des Proof of Concepts zur Bewertung (geschlossene Gruppe).
26.–27. September: Muss unser Proof of Concept vor der Veröffentlichung angepasst werden? Benötigen wir mehr Zeit? Passen Sie sie entsprechend an. (Report #6)
30. September bis 9. Oktober: Proof of Concept wird veröffentlicht. Zweiter Feedbackzyklus (öffentliche Gruppe)
10.–15. Oktober: Letzte Bewertung und Anpassung des Proof of Concepts. (Bericht 7)
16.–20. Oktober: Kleine Pause von den Aktivitäten [1].
21. Oktober bis 23. November: Der Public Style Guide ist endgültig (Bericht Nr. 8). Anwendung aller Anweisungen im Styleguide auf alle Seiten der Nutzerdokumentation (Bericht 9). Bericht mit der Bewertung aller durchgeführten Aktivitäten und weiteren Empfehlungen für die Community (Bericht Nr. 10).
Die Projektdauer kann auf Anfrage verlängert werden.
[1]: Reise, die vor meiner Bewerbung für Season of Docs geplant war.
Liefergegenstände – Zehn öffentliche Berichte zu den durchgeführten Aktivitäten – Ein öffentlicher Stilleitfaden, der sowohl von Open Collective als auch von externen Mitwirkenden verwendet werden kann – Überarbeitete Seiten mit Nutzerdokumentation