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:
- Sehr gut
- Technischer Redakteur:
- @anindita_basu
- Projektname:
- Im-Produkt-Text überprüfen und optimieren
- Projektlänge:
- Lang andauernd (5 Monate)
Projektbeschreibung
Ich bin dem Slack-Kanal beigetreten und habe Eric einige Fragen gestellt. Basierend auf seiner Antwort (vielen Dank, Eric!),
Ich schlage vor, dieses Projekt
folgendermaßen anzugehen:
Strings klassifizieren
Zuerst finde ich heraus, welche der Strings (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) Systemkonsolen-Strings sind und welche für Nutzer sichtbar sind. Ich schlage vor, zuerst die für Nutzer sichtbaren Strings zu überprüfen.
Einen Styleguide für die Zeichenfolgen erstellen
Ich möchte den Stil für Groß- und Kleinschreibung, Länge und Wortgebrauch für Strings definieren, die in Menüpunkten, Aktionsschaltflächen, Labels, Überschriften, Kurzinfos, Fehlern, Warnungen, Validierungen, Benachrichtigungen und Bestätigungen verwendet werden. (Siehe Beispielscreenshot des Styleguides unter https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG.) Außerdem möchte ich einige Hinweise zur Verwendung von Tokens (Platzhaltern) in Strings geben, insbesondere in zusammengesetzten Strings.
Ich versuche, diese Anleitung auf eine A4-Seite zu beschränken, nach Möglichkeit kürzer. Die Entwickler, die diese Strings tatsächlich schreiben, sollten die Anleitung schnell und einfach finden. Wenn sie befolgt wird, ist der UI-Text auf allen Bildschirmen einheitlich.
Ich schlage dies aus zwei Gründen vor: (a) Damit der Text in Bezug auf Grammatik und Stil einheitlich ist. (b) Damit es auch nach dem Ende des GSoD eine Reihe von Anweisungen gibt, auf die sich jeder schnell beziehen kann, wenn er UI-Text schreibt.
Text prüfen und optimieren
Basierend auf dem in Schritt 2 erstellten Styleguide bearbeite ich die Strings und erstelle Pull-Anfragen auf GitHub.
=============
Dauer
Ich weiß noch nicht, wie viele der Strings für Nutzer sichtbar sind. Das möchte ich in diesem Projekt überprüfen. Ich schätze, dass die Erstellung des Styleguides etwa drei Wochen dauern wird (vom Entwurf bis zur Genehmigung). Diese Arbeit kann gleichzeitig mit der Kategorisierung von Strings als Systemstrings oder für Nutzer ausgeführt werden. Ich gehe davon aus, dass das Projekt eine Standardlänge von drei Monaten hat und ich nur so viele Strings zur Überprüfung annehme, wie in diesem Zeitraum möglich sind.
Da ich bereits in Vollzeit angestellt bin, kann ich nur einen Teil des Tages an diesem Projekt arbeiten. Ich bin offen für ein Projekt mit längerer Dauer, wenn Sie der Meinung sind, dass dies aufgrund meiner reduzierten Arbeitszeit erforderlich ist.