Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source
- Najważniejszy aspekt
- Pisarz techniczny:
- @anindita_basu
- Nazwa projektu:
- Sprawdzanie i precyzowanie tekstu w usłudze
- Długość projektu:
- Długookresowa (5 miesięcy)
Opis projektu
Dołączyłem do kanału Slack i zadałem kilka pytań Ericowi. Na podstawie
jego odpowiedzi (Dziękuję, Eric!) Proponuję podejście do tego projektu
w ten sposób:
Klasyfikowanie ciągów znaków
Zacznę od określenia, które ciągi (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) są ciągami konsoli systemowej, a które są przeznaczone dla użytkowników. Proponuję, aby najpierw sprawdzić ciągi znaków wyświetlane użytkownikom.
Utwórz przewodnik redakcyjny dla ciągów tekstowych.
Chcę zdefiniować styl wielkich liter, długości i używania słów w przypadku ciągów znaków używanych w elementach menu, przyciskach akcji, etykietach, nagłówkach, etykietkach narzędzi, błędach, ostrzeżeniach, weryfikacjach, powiadomieniach i potwierdzeniech (patrz zrzut ekranu przykładowego przewodnika po stylu na stronie https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Chcę też przygotować wskazówki dotyczące korzystania z tokenów (symboli zastępczych) w ciągach znaków, zwłaszcza w przypadku ciągów złożonych.
Staram się, aby te wskazówki mieściły się na jednej stronie formatu A4, a jeśli to możliwe, aby były krótsze. Intencją jest, aby deweloperzy, którzy piszą te ciągi znaków, mogli szybko i łatwo korzystać z instrukcji, a teksty w interfejsie będą spójne na wszystkich ekranach.
Proponuję to z 2 powodów: (a) aby zapewnić spójność tekstu pod względem gramatyki i stylu oraz (b) aby nawet po zakończeniu GSoD był dostępny zestaw instrukcji, do których każdy może szybko zajrzeć podczas pisania tekstu interfejsu.
Sprawdź i popraw tekst
Korzystając z poradnika stylu utworzonego w punkcie nr 2, wyedytuję ciągi znaków i utworzę żądania pull na GitHubie.
=============
Czas trwania
Nie wiem jeszcze, ile ciągów tekstowych jest widocznych dla użytkowników (to właśnie proponuję sprawdzić w ramach tego projektu). Szacuję, że stworzenie przewodnika redakcyjnego zajmie około 3 tygodni (od wersji roboczej do zatwierdzenia). Można to zrobić jednocześnie z podziałem ciągów tekstowych na ciągi tekstowe systemu i teksty wyświetlane użytkownikom. Proponuję zacząć od założenia, że projekt będzie miał standardową długość (3 miesiące), w którym wezmę pod uwagę tylko tyle ciągów znaków do sprawdzenia, ile będzie możliwe w tym czasie.
Mam już pełny etat, więc będę mogła poświęcić na ten projekt tylko część dnia. Jeśli uważasz, że ze względu na skrócenie czasu pracy konieczne jest przedłużenie projektu, jestem na taką opcję otwarty.