Jak sprawdzać terminy techniczne, wielkie litery i przetłumaczone etykiety

Przewodniki stylistyczne podają przydatne zasady domyślne, ale w produkcie lub danej dziedzinie mogą funkcjonować ustalone nazwy wymagające innego zapisu. Przewodnik Google dla deweloperów zaleca stosowanie standardowej amerykańskiej kapitalizacji oraz zapisywanie wielką literą tylko pierwszego wyrazu w nagłówkach, listach i tabelach, z zachowaniem oficjalnych nazw produktów i form kodu. Przewodnik Microsoft również zaleca zapis wielką literą tylko pierwszego wyrazu, ale wyraźnie zastrzega użycie wielkich liter w nazwach własnych, takich jak marki, produkty i usługi. Wspólna zasada domyślna to punkt wyjścia, a nie dowód na to, że dany termin techniczny jest pospolity. Wskazówki Google dotyczące wielkich liter Wskazówki Microsoft dotyczące wielkich liter

Lista słów odpowiada na inne pytanie niż ogólne zasady kapitalizacji: jaką pisownię lub sposób użycia zaleca konkretny przewodnik redakcyjny w przypadku określonych terminów. Na przykład lista słów Google odsyła czytelników do preferowanego słownika w przypadku haseł, których nie obejmuje, i odróżnia wskazówki stylistyczne od sprawdzania definicji technicznej w wiarygodnej dokumentacji. Ten podział jest przydatny: spójność redakcyjna i poprawność techniczna wymagają dowodów ze źródeł odpowiednich dla każdego z tych zagadnień. Lista słów Google

Utwórz osobny wiersz dla każdego terminu, który można niespójnie zmienić lub błędnie przetłumaczyć. Ten hipotetyczny przykład pokazuje pola i sposób podejmowania decyzji; „Sync token” i jego tłumaczenie są wyłącznie ilustracją, a nie informacją o rzeczywistym produkcie ani zatwierdzonej terminologii.

Zadaniem tabeli jest zachowanie decyzji i ich zakresu. Dopuszczalna forma pisana małą literą nie powinna po cichu zmienić się w drugą nazwę produktu; identyfikatora nie należy „poprawiać”, aby pasował do tekstu; a nierozstrzygnięte tłumaczenie powinno pozostać wyraźnie oznaczone jako nierozstrzygnięte. Gdy oficjalne źródło jest sprzeczne z lokalnym glosariuszem, zapisz sprzeczność i źródło ostatecznej decyzji, zamiast łączyć formy w niewyjaśnioną listę.

Najpierw ustal, do czego odnosi się termin: zwykłego pojęcia, marki lub nazwy produktu, etykiety interfejsu czy dosłownego identyfikatora. Sprawdź oficjalną formę w odpowiedniej dokumentacji produktu lub glosariuszu. Następnie zastosuj zasady stylistyczne docelowej publikacji do zwykłego tekstu, nagłówków i etykiet, zachowując udokumentowane wyjątki dotyczące nazw i identyfikatorów. Google odradza niepotrzebne użycie wielkich liter i ostrzega przed odróżnianiem znaczeń wyłącznie za ich pomocą; Microsoft podobnie zaleca w swoim podejściu zapis wielką literą tylko pierwszego wyrazu oraz nazw własnych. Wskazówki Google dotyczące wielkich liter Wskazówki Microsoft dotyczące wielkich liter

Następnie porównaj formę z listą słów i słownikiem danej organizacji, jeśli ma to zastosowanie. Zapisz źródło oraz jego wersję lub datę sprawdzenia, aby inny redaktor mógł odtworzyć tok rozumowania. Nie wnioskuj o oficjalnym statusie na podstawie atrakcyjnie wyglądającej pisowni wielką literą, wyniku wyszukiwania ani tłumaczenia przypominającego angielski termin. Jeśli źródła są sprzeczne lub nie określają formy, oznacz wiersz jako wymagający decyzji, zamiast przedstawiać przypuszczenie jako ustaloną terminologię.

Traktuj tłumaczenie jako decyzję dotyczącą znaczenia i kontekstu, a nie mechaniczną zmianę wielkości liter. Etykieta może podlegać ograniczeniom interfejsu, ustalonej zlokalizowanej terminologii produktu lub innej formie gramatycznej w języku docelowym. Porównaj proponowaną formę z zatwierdzonymi materiałami lokalnymi i kontekstem, w którym zetkną się z nią czytelnicy. Jeśli nie ma wiarygodnej zlokalizowanej formy, oznacz tłumaczenie jako nierozstrzygnięte i poproś o odpowiednią decyzję terminologiczną; nie wymyślaj rzekomo oficjalnego odpowiednika.

Po ustaleniu terminu sprawdź właściwą etykietę w jej kontekście. Sprawdź, czy wielkość liter odpowiada zasadom wybranego języka oraz właściwemu stylowi produktu lub redakcji. Zachowaj w zapisie terminu oryginalną etykietę oraz jej źródło i status, aby przy kolejnej edycji nie pomylono tymczasowego tłumaczenia z zatwierdzonym. Jeśli etykieta jest też przywołana w instrukcjach, sprawdź, czy tekst podaje dokładnie to samo brzmienie co na ekranie.

Przed zmianą wielkości liter oddziel dosłowne ciągi znaków od tekstu redakcyjnego. Porównaj identyfikatory znak po znaku z odpowiednią dokumentacją API, schematem, kodem lub interfejsem. Zachowaj podkreślenia, wielkie i małe litery, odstępy oraz interpunkcję, jeśli określa je źródło; normalizacja stylistyczna należy do otaczających objaśnień, a nie do dosłownej wartości. Przewodnik Google wyraźnie dopuszcza zapis wielkimi literami lub camelCase w oficjalnych nazwach albo przy odwołaniach do kodu, który używa tych form. Wskazówki Google dotyczące wielkich liter

Podczas praktycznego przeglądu oznacz w tabeli chronione identyfikatory, a następnie porównaj z tym wzorcem każde ich wystąpienie. Jeśli zdanie w tekście używa terminu zapisanego jak w kodzie jako zwykłego rzeczownika, zdecyduj, czy wyjaśnić go przystępniejszym językiem, zachowując dosłowny identyfikator w formatowaniu kodu. Jeśli sama wiarygodna definicja jest niejasna, zapisz tę niepewność; przewodnik stylistyczny nie określa działania API ani kanonicznej nazwy pola.

Ta kolejność pomaga w korekcie, ale nie stanowi automatycznego tłumaczenia ani uniwersalnej zasady użycia wielkich liter. Jej zaletą jest to, że pozwala sprawdzić każdą decyzję redakcyjną: jaką formę wybrano, skąd pochodzi, gdzie obowiązuje i co wciąż wymaga rozstrzygnięcia. W przypadku krótkiego dokumentu wystarczy niewielka tabela; przy dużym zestawie terminów zachowaj te same pola w przyjętym przez zespół obiegu pracy z glosariuszem.