Wyjaśnij zadanie i decyzję
W tym przewodniku terminologia i glosariusze stają się możliwym do przeglądu przepływem pracy. Łączy decyzje dotyczące domeny, własność, dowody i akceptację, dzięki czemu wynik nadal sprawdza się w produkcji.
Traktuj terminologię jako treść podlegającą regulacjom z właścicielami, statusami, zatwierdzonymi wyjaśnieniami i kontrolowanymi wyjątkami.
Praktyczny proces
- 1
Zdefiniuj odbiorców na podstawie dowodów, w tym doświadczenia czytelniczego, kontekstu, urządzenia i dostępnego wsparcia.
- 2
Wybierz jedno prawdziwe zadanie i określ, co musi zrozumieć lub zrobić odnoszący sukcesy czytelnik.
- 3
Utwórz wersję językową, zachowując każdy istotny dla decyzji fakt, warunek, datę i ścieżkę kontaktu.
- 4
Przeprowadź recenzję specjalistyczną i redakcyjną z zapisanymi kryteriami akceptacji.
- 5
Przetestuj z członkami docelowej grupy odbiorców, zapisz ustalenia, weryfikuj i zatwierdzaj publikację.
Przykład lub narzędzie
Rekord glosariusza zawiera terminy preferowane, zabronione i specyficzne dla odbiorców zgodnie ze wskazówkami CMS. W narzędziu zapisz także punkt odniesienia, właściciela, decyzję, dowody, otwartą kwestię i datę zatwierdzenia. Użyj prawdziwej strony lub transakcji, aby zespół mógł zobaczyć zależności, wyjątki i prace konserwacyjne następujące po wydaniu.
| Punkt decyzji | Nagrywać | Kryterium akceptacji |
|---|---|---|
| Linia bazowa | Zaobserwowany stan obecny | Źródło i data zapisu |
| Decyzja | Wybrana opcja i uzasadnienie | Uwzględniono ryzyko i odbiorców |
| Dowód | Testuj, dokumentuj lub mierz | Możliwość przeglądu i specyficzna dla wersji |
| Aprobata | Imię i nazwisko, rola i data | Wszystkie obowiązkowe kryteria spełnione |
Niech każdy termin będzie regulowanym zapisem
Przydatny słownik to coś więcej niż tylko lista preferowanych słów. Każdy rekord powinien zawierać stabilny identyfikator, preferowany termin, zabronione lub przestarzałe warianty, definicję, wyjaśnienie odbiorców, formy gramatyczne, przykłady, tryb językowy, domenę, właściciela, status, datę zatwierdzenia, źródło i wyzwalacz recenzji. Zachowaj definicję techniczną oddzielnie od sformułowań pokazywanych czytelnikom. Dokładna definicja wewnętrzna może wspierać kilka wyjaśnień specyficznych dla odbiorców, nie pozwalając na dryfowanie ich znaczeń.
Używaj wyraźnych statusów: zaproponowane, w trakcie sprawdzania, zatwierdzone, przestarzałe i zabronione. Tylko zatwierdzone zapisy są oferowane autorom lub stosowane przez zautomatyzowane systemy. Przestarzały termin nadal będzie można wyszukiwać, dzięki czemu będzie można znaleźć i przenieść starą treść. Zabroniony termin zawiera przyczynę i zatwierdzoną wymianę, co pomaga redaktorom rozwiązać ostrzeżenie bez zgadywania. Wersjonuj każdą decyzję i zachowaj poprzednią wartość na potrzeby audytu i wycofania.
| Pole | Przykład | Zasada akceptacji |
|---|---|---|
| Preferowany termin | biuro świadczeń | Jeden zatwierdzony formularz na domenę i tryb językowy |
| Wyjaśnienie publiczności | Urząd, który sprawdza i wypłaca Twoje świadczenie | Znaczenie zachowane i przetestowane dla odbiorców |
| Status | Zatwierdzony | Właściciel, recenzent i data zapisu |
| Wyjątek | Oficjalny tytuł formularza zachowuje termin prawny | Zakres, przyczyna i wygaśnięcie są udokumentowane |
Uruchom powtarzalny przepływ pracy dotyczący terminu i decyzji
Zbieraj kandydatów z dzienników wyszukiwania, pytań wsparcia, komentarzy recenzentów, zmian zasad i powtarzających się ręcznych poprawek. Przed utworzeniem nowego rekordu przeszukaj istniejące terminy, warianty i powiązane koncepcje. Termin właściciel zapisuje definicję i identyfikuje wiarygodne źródło. Specjalista merytoryczny potwierdza znaczenie, redaktor proponuje czytelnikowi sformułowanie, a specjalista ds. dostępności sprawdza wybrane tryby językowe. Przetestuj wywierające wpływ wyjaśnienia z docelowymi czytelnikami.
Następnie grupa terminologiczna zatwierdza, odrzuca dowody lub żąda dowodów. Posiedzenia powinny odbywać się według przewidywalnego harmonogramu i zawierać pilną trasę zmian prawnych lub usługowych. Decyzje określają, gdzie dany termin ma zastosowanie, a gdzie nie. Na przykład strona w prostym języku może zawierać informację „biuro świadczeń”, podczas gdy pole wniosku musi zawierać nazwę organu ustawowego. Wyjątek należy do tego samego rekordu, więc autorzy widzą oba wybory w kontekście.
- 1
Uchwyć termin kandydata i treść tam, gdzie sprawiał on trudności.
- 2
Potwierdź koncepcję, domenę, wiarygodne źródło i odbiorców, których to dotyczy.
- 3
Przygotuj preferowany tekst, wyjaśnienia, warianty i wytyczne dotyczące migracji.
- 4
Przejrzyj znaczenie, tryb językowy, dostępność i wpływ operacyjny.
- 5
Zatwierdź i opublikuj wersjonowany rekord, a następnie zaktualizuj treść, której dotyczy problem.
Zintegruj terminologię z tworzeniem i dostarczaniem
Udostępnij glosariusz poprzez API lub zsynchronizowane repozytorium ze stabilnymi identyfikatorami. CMS powinien podkreślać zabronione i przestarzałe terminy, pokazywać preferowane zamienniki i wyjaśnienia oraz umożliwiać autorom otwarcie pełnej decyzji. Sugestie muszą uwzględniać ustawienia regionalne, domenę, typ treści i tryb językowy. Nie zastępuj słów automatycznie, jeśli gramatyka lub kontekst prawny może zmienić znaczenie. Wymagaj od autora zaakceptowania sugestii lub zarejestrowania regulowanego wyjątku.
Przechowuj wersję glosariusza używaną dla każdej wersji językowej. Kiedy zatwierdzony termin ulegnie zmianie, zapytaj CMS o rekordy, których to dotyczy, i utwórz zadania przeglądu według ryzyka. Sprawdzanie podglądu może blokować nowe zabronione terminy, brakujące wyjaśnienia dotyczące pierwszego użycia lub wygasły wyjątek. Dostarczanie w czasie wykonywania nie powinno zależeć od żądania glosariusza na żywo. Rozwiąż i zweryfikuj terminy przed publikacją, aby awaria terminologii nie mogła zmienić ani zablokować opublikowanych stron.
Sugestie CMS wykorzystują stabilne identyfikatory terminów, a nie samo dopasowywanie tekstu.
Respektowane są ustawienia regionalne, domena, tryb językowy i forma gramatyczna.
Automatyczne kontrole wyjaśniają rozwiązanie, a nie tylko zgłaszają błąd.
Wyjątki mają zakres, właściciela, dowody i wygaśnięcie.
Zmiana glosariusza powoduje utworzenie zadań przeglądu opublikowanych treści, których dotyczy problem.
Mierz adopcję i rozwiązuj konflikty
Śledź użycie preferowanych terminów, nowe ustalenia dotyczące zakazanych terminów, nierozwiązanych kandydatów, średni czas podejmowania decyzji, wygasłe wyjątki i treści oczekujące na migrację. Połącz te środki operacyjne ze zrozumieniem dowodów i zapotrzebowaniem na wsparcie. Wysoki wskaźnik adopcji nie dowodzi, że wyjaśnienie działa. Jeśli czytelnicy nadal nie rozumieją zatwierdzonego terminu, otwórz ponownie decyzję i zachowaj dowody, które spowodowały zmianę.
Jeśli działy potrzebują różnych sformułowań, należy ustalić, czy mają na myśli to samo pojęcie. Jeśli koncepcja jest inna, utwórz połączone rekordy z wyraźnymi domenami. Jeśli tylko odbiorcy się różnią, zachowaj jedną podstawową definicję i podaj osobne wyjaśnienia dla odbiorców. Przypisz specjalistę ds. terminologii, który będzie rozstrzygał spory dotyczące własności i zapobiegał duplikacjom zapisów. Co najmniej raz w roku przeglądaj warunki o największym wpływie oraz za każdym razem, gdy zmienią się obowiązujące przepisy, proces świadczenia usług lub wybrany standard językowy.
Role, dowody i zatwierdzenie
Jakość języka to odpowiedzialność operacyjna. Daj właścicielowi źródła odpowiedzialność za rzetelność faktów, redaktorowi odpowiedzialność za przejrzystość, specjalistom odpowiedzialność za zasady dostępności i właścicielowi produktu odpowiedzialność za publikację. Zapis wydania powinien określać wersję źródłową, tryb językowy, recenzentów, dowody testowe, datę zatwierdzenia i zdarzenie, które powoduje nową recenzję.
Eksploatacja i konserwacja
Praca nie kończy się w momencie publikacji. Połącz wersję językową lub konfigurację ze źródłem, monitoruj jakość i miary usług oraz zdefiniuj konkretne wyzwalacze przeglądu. Wyzwalacze obejmują zmiany źródła, zmiany prawne, nowe potrzeby odbiorców, powtarzające się pytania dotyczące pomocy, zmiany techniczne i incydenty. Nazwany właściciel ocenia wyzwalacz, w razie potrzeby otwiera nową wersję i rejestruje ponowne zatwierdzenie.
Lista kontrolna przed publikacją
Publiczność i zadanie są jasno określone.
Wszystkie fakty prawne i operacyjne odpowiadają źródłu.
Daty, kwoty, warunki i wyjątki są kompletne.
Nagłówki opisują pytania lub działania czytelnika.
Łącza i kontrolki mają znaczące etykiety.
Terminologia specjalistyczna jest wyjaśniona w sposób spójny.
Docelowa publiczność przetestowała krytyczną podróż.
Rejestrowane są prawa własności i kolejna inicjacja przeglądu.