Mattermost-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:

Mattermost

Technischer Redakteur:

@anindita_basu

Projektname:

Produktinternen Text prüfen und optimieren

Projektdauer:

Lange Ausführung (5 Monate)

Projektbeschreibung

Ich bin dem Slack-Kanal beigetreten und habe ein paar Fragen an Eric gesendet. Basierend auf
seiner Antwort (Danke, Eric!), Ich schlage vor, das Projekt
so anzugehen:

1. Strings klassifizieren

   Zuerst ermittle ich, welche der Strings (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) Systemkonsolen sind und welche für Nutzer sind. Ich schlage vor, zuerst die für die Nutzer sichtbaren Strings zur Überprüfung zu verwenden.

2. Erstellen eines Styleguides für die Strings

   Ich möchte den Stil für Großschreibung, Länge und Wortverwendung für Strings definieren, die in Menüelementen, Aktionsschaltflächen, Labels, Überschriften, Kurzinfos, Fehlern, Warnungen, Validierungen, Benachrichtigungen und Bestätigungen verwendet werden (siehe Beispiel-Screenshot unter https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Außerdem möchte ich Ihnen Hinweise zur Verwendung von Tokens (Platzhaltern) in Strings geben, insbesondere in zusammengesetzten Strings.

   Ich versuche, diese Anleitung auf einer Seite eines DIN-A4-Tabellenblatts zu beschränken, wenn möglich, kürzer. Entwickler, die diese Strings tatsächlich schreiben, sollten die Anleitungen schnell und einfach zu verwenden finden. Außerdem sollte der UI-Text auf allen Bildschirmen einheitlich sein.

   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 Ende der GSoD eine Reihe von Anweisungen gibt, auf die sich jeder beim Schreiben von UI-Texten schnell beziehen kann.

3. Überprüfen und optimieren Sie den Text.

   Basierend auf dem unter Punkt 2 erstellten Styleguide werde ich die Strings bearbeiten und Pull-Anfragen auf GitHub erstellen.

=============

Dauer

Ich weiß noch nicht, wie viele der Strings nutzerseitige Strings sind (und wie ich vorschlage, sie in diesem Projekt zur Überprüfung in Anspruch zu nehmen). Ich schätze, dass das Erstellen des Styleguides etwa 3 Wochen dauern würde (vom Entwurf bis zur Genehmigung). Diese Arbeit kann gleichzeitig mit der Kategorisierung von Zeichenfolgen als Systemstrings oder für den Nutzer durchgeführt werden. Ich schlage vor, mit der Annahme zu beginnen, dass das Projekt ein Projekt mit Standardlänge (3 Monate) sein wird, bei dem ich nur so viele Strings zur Überprüfung beziehe, 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 längerfristiges Projekt, wenn Sie der Meinung sind, dass meine verkürzte Arbeitszeit es brauchen würde.