Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Najbardziej uzależniona od wydarzenia
- Pisarz techniczny:
- @anindita_basu
- Nazwa projektu:
- Sprawdź i popraw tekst w produkcie
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
Weszła na kanał na Slacku i zadawałam Erykowi kilka pytań. Na podstawie
jego odpowiedzi (dziękuję, Eric!), Proponuję podejście do tego projektu
w następujący sposób:
Sklasyfikuj ciągi tekstowe
Zacznę od określenia, które z ciągów (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) są przeznaczone dla konsoli systemowej, a które są widoczne dla użytkowników. Proponuję na początku przesłać do sprawdzenia ciągi tekstowe widoczne dla użytkowników.
Utwórz wskazówki redakcyjne dotyczące ciągów znaków
Chcę zdefiniować styl wielkich liter, długości i wyrazów użycia słów w elementach menu, przyciskach działań, etykietach, nagłówkach, etykietkach, błędach, ostrzeżeniach, walidacjach, powiadomieniach i potwierdzeniach (zobacz przykładowy zrzut ekranu przewodnika po stylu na stronie https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Przydałaby się też pomoc w korzystaniu z tokenów (zmiennych) w ciągach tekstowych, a zwłaszcza ciągów złożonych.
Zależy mi na tym, aby była ona krótsza na 1 stronie arkusza w formacie A4. Z myślą o deweloperach, którzy je piszą, wskazówki powinny być szybkie i łatwe w użyciu. Po ich zastosowaniu tekst interfejsu będzie spójny na wszystkich ekranach.
Proponuję zrobić to z 2 powodów: (a) aby zachować spójność tekstu w zakresie gramatyki i stylu; (b) aby nawet po zakończeniu GSoD istniał zestaw instrukcji, do których każdy może szybko się odwoływać podczas pisania tekstu interfejsu.
Sprawdzanie i ulepszanie tekstu
Na podstawie przewodnika po stylu nr 2 zedytuję ciągi tekstowe i utworzę żądania pull na GitHubie.
=============
Czas trwania
Nie wiem jeszcze, ile z nich to ciągi tekstowe przeznaczone dla użytkowników (właśnie to proponuję sprawdzić w tym projekcie). Szacuję, że opracowanie przewodnika stylistycznego zajmie około 3 tygodni (od wersji roboczej do zatwierdzenia) i można to zrobić jednocześnie z kategoryzacją ciągów tekstowych lub prezentowanych użytkownikowi. Na początku zakładamy, że projekt to projekt o standardowej długości (3 miesiące), w ramach którego wybieram tylko tyle ciągów do weryfikacji, ile jest możliwe w tym czasie.
Ponieważ pracuję już na pełny etat, mogę pracować nad tym projektem tylko przez część dnia. Jeśli uważam, że będzie to potrzebne w przypadku skróconych godzin pracy, mogę wziąć udział w projekcie o dłuższym czasie trwania.