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:
- Mattermost
- Technischer Redakteur:
- @anindita_basu
- Projektname:
- Produktinterne Texte überprüfen und optimieren
- Projektdauer:
- Langfristig (5 Monate)
Projektbeschreibung
Ich bin dem Slack-Kanal beigetreten und habe ein paar Fragen an Eric gesendet. Auf Grundlage seiner Antwort (Danke, Eric!)
Ich schlage vor, dieses Projekt
so anzugehen:
Strings klassifizieren
Ich beginne damit, herauszufinden, 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 nutzerseitigen Strings zur Überprüfung zu nehmen.
Einen Styleguide für die Strings erstellen
Ich möchte den Stil für Großschreibung, Länge und Wortnutzung für Strings definieren, die in Menüpunkten, 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 einige Hinweise zur Verwendung von Tokens (Platzhaltern) in Strings geben, insbesondere in zusammengesetzten Strings.
Ich versuche, diese Anleitung auf eine Seite einer DIN-A4-Seite zu beschränken und möglichst kürzer. Entwickler, die diese Strings tatsächlich schreiben, sollten die Anleitung schnell und einfach zu verwenden finden. Außerdem wird der UI-Text, wenn er befolgt wird, auf allen Bildschirmen einheitlich dargestellt.
Ich schlage das aus zwei Gründen vor: (a) Damit der Text in Bezug auf Grammatik und Stil einheitlich ist, und (b) dass es auch nach dem GSoD eine Reihe von Anweisungen gibt, auf die sich jeder beim Schreiben von UI-Texten schnell beziehen kann.
Überprüfen und optimieren Sie den Text.
Basierend auf dem unter Punkt 2 erstellten Styleguide bearbeite ich die Strings und erstelle Pull-Anfragen auf GitHub.
=============
Dauer
Ich weiß noch nicht, wie viele der Strings nutzerseitige Strings sind (was ich vorschlage, die Überprüfung in diesem Projekt in die Wege zu leiten). Ich schätze, dass die Erstellung des Styleguides etwa 3 Wochen (vom Entwurf bis zur Genehmigung) dauern würde. Diese Arbeit kann gleichzeitig mit der Kategorisierung von Zeichenfolgen als Systemstrings oder für die Nutzenden 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 wie möglich zur Überprüfung übertrage.
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 benötigen würde.