Style Guide

Przewodnik po stylu to udokumentowany zbiór standardów regulujących sposób tworzenia treści, obejmujący elementy wizualne, język pisany lub oba te elementy. Przewodniki wizualne określają typografię, kolor, odstępy, sposób prezentacji obrazów i użycie logo; przewodniki po treści określają ton, terminologię, kapitalizację, konwencje formatowania oraz sposób obsługi powtarzających się elementów, takich jak daty, liczby i komunikaty o błędach.

Celem jest zapewnienie spójności bez konieczności ponownego rozpatrywania każdej decyzji. Bez udokumentowanych standardów każda nowa strona, kampania lub ekran są tworzone zgodnie z osądem osoby, która je stworzyła, a organizacja gromadzi kilkanaście nieznacznie różniących się ujęć tego samego elementu. Koszty pojawiają się w postaci niespójności wizualnej, niespójnej terminologii, która dezorientuje klientów, oraz czasu spędzonego na debatowaniu nad decyzjami podjętymi lata temu.

Najbardziej przydatne przewodniki mają charakter normatywny i szczegółowy, a nie opisowy i aspiracyjny. Stwierdzenie, że głos marki jest przyjazny, ale profesjonalny, nie stanowi żadnej wskazówki dla osoby piszącej komunikat o błędzie. Przewodnik przedstawiający preferowane i odrzucane sformułowania w typowych sytuacjach, wraz z uzasadnieniem, jest bezpośrednio użyteczny. Testem jest to, czy nowy współpracownik będzie w stanie stworzyć pracę zgodną z zasadami na podstawie samego dokumentu.

Decyzje terminologiczne często stanowią najcenniejszą treść, a jednocześnie są najbardziej zaniedbywane. Decyzja o tym, jak organizacja nazywa każdy produkt, funkcję i proces, oraz udokumentowanie alternatyw, których nie należy używać, zapobiega sytuacji, w której dział marketingu, produkt, wsparcie techniczne i dokumentacja używają różnych słów na określenie tego samego. Klienci napotykający trzy nazwy dla jednego pojęcia, słusznie wnioskują, że chodzi o trzy różne rzeczy.

Przewodniki zawodzą przede wszystkim z powodu braku egzekwowania, a nie z powodu słabej treści. Dokument, który został napisany, rozpowszechniony i nigdy więcej się do niego nie odwołuje, szybko zostaje zastąpiony przez niespójne praktyki, a wersja, którą ludzie faktycznie stosują, staje się tym, co wyglądało na podstawie ostatniej podobnej pracy. Skuteczne mechanizmy egzekwowania obejmują osadzanie reguł w narzędziach, takie jak linting dla standardów treści oraz ograniczanie możliwości wyboru w projektowaniu i bibliotekach komponentów, co sprawia, że ​​przestrzeganie zasad jest ścieżką najmniejszego oporu.

Utrzymanie dokumentu decyduje o jego wiarygodności. Normy, które nie odzwierciedlają już aktualnej praktyki, są selektywnie ignorowane, a selektywne przestrzeganie staje się powszechnym nieprzestrzeganiem. Przypisanie odpowiedzialności, umożliwienie proponowania zmian i okresowe przeglądy zapewniają aktualność dokumentu, a dokumentowanie uzasadnienia decyzji zapobiega ich przypadkowemu cofnięciu przez osobę nieznającą przyczyn ich podjęcia.

Zakres powinien odpowiadać temu, co organizacja realnie jest w stanie utrzymać. Kompleksowe przewodniki obejmujące każdy możliwy przypadek stają się na tyle obszerne, że nikt ich nie czyta, i na tyle nieaktualne, że nikt im nie ufa. Zwięzły przewodnik obejmujący decyzje, które rzeczywiście się powtarzają, rozszerzany tylko w przypadku powtarzających się istotnych niejasności, pozostaje aktualny i pozostaje w użyciu, a dyscyplina w unikaniu dokumentowania rzadkich przypadków sprawia, że ​​tak pozostaje.

Warto rozróżnić relację z systemem projektowym. Przewodnik stylistyczny dokumentuje decyzje i reguły; system projektowy dostarcza zaimplementowane komponenty, które je ucieleśniają. Sam przewodnik opiera się na tym, że ludzie go czytają i stosują, podczas gdy komponenty automatycznie egzekwują standard wszędzie tam, gdzie są używane. Tam, gdzie występują oba te elementy, przewodnik obejmuje to, czego komponenty nie mogą, w tym ton, terminologię i decyzje wymagające osądu.

Ponieważ wartość wynika z przyjęcia, a nie z dokumentacji, wysiłek włożony w mechanizmy egzekwowania zazwyczaj przynosi większe korzyści niż wysiłek włożony w rozszerzanie przewodnika. W praktyce standardy wizualne i komponentowe są ustalane w ramach projekt produktu i zakodowane w systemie projektowym, standardy językowe i terminologiczne są uzgadniane usługi marketingowe tak, aby słownictwo skierowane do klienta było spójne w całym produkcie i jego promocji, a własność zwykle leży po stronie Dział UX tam gdzie taki istnieje.