Jak pisać dokumentację użytkownika dla przewodnika po stylu sieciowym

Poradniki stylu określają zasady użytkowania wizualnych elementów marki; są one powszechnie używane przez organizacje, które chcą zachować spójny obraz treści tworzonych przez wiele osób. Przewodnik po stylu sieciowym jest szczególnie ważny, jeśli treść online jest tworzona i edytowana przez użytkowników o różnych poziomach umiejętności. Określając szczegółowe zasady dotyczące stron internetowych powiązanych z Twoją organizacją, możesz pomóc zapewnić, że każda strona będzie promować profesjonalną, spójną tożsamość. Podczas pisania dokumentacji użytkownika dla przewodnika po stylach używaj jasnego, zwięzłego języka i pisz do użytkowników o najniższych poziomach umiejętności projektowania stron internetowych.

1.

Otwórz dokumentację z ogólnym wyjaśnieniem układu stron internetowych i stylu dla każdego typu strony. Mimo że określone kategorie stron różnią się w zależności od organizacji, należy rozważyć strony docelowe, strony tytułowe, strony główne, strony podkategorii, strony tylko do obrazów i strony tekstowe. Użyj diagramu strukturalnego do wyjaśnienia złożonych hierarchii informacji i dołącz grafikę pokazującą przykłady każdego układu.

2.

Wyjaśnij, w jaki sposób można używać logo na różnych typach stron internetowych. Daj znać użytkownikom, gdzie należy umieścić logo i podaj górny i dolny limit rozmiaru. Jeśli masz wiele układów logo i odmian kolorystycznych, podaj miejsca, w których mogą być używane; używanie samego znaku logo może być dozwolone na stronie, która na przykład używa pełnego tytułu organizacji w tytule. Dołącz pliki z logo do dokumentacji z wymiarami, aby ułatwić użytkownikom zapisanie prawidłowej wersji. Zamknij tekst ze zdaniem ostrzegającym użytkowników, aby nie zmieniali kolorów, kształtu, rozmiaru ani układu logo, aby zapobiec nieautoryzowanym zmianom.

3.

Wymień określone czcionki, które muszą być używane na wszystkich stronach internetowych Twojej organizacji. Dołącz czcionki dla nagłówków, podtytułów, tytułów, tekstu głównego, podpisów i cytatów. Dla każdej kategorii określ nazwę, rozmiar czcionki oraz informację, czy jest pogrubiony, pochylony, podkreślony czy pisany wielkimi literami.

4.

Napisz o wyjątkach w sieci Web do przewodnika po trybie offline w organizacji. Dołącz elementy, które nie stanowią problemu w przypadku materiałów drukowanych, takie jak prezentowanie linków w tekście lub uwzględnianie zewnętrznych źródeł na końcu strony. Jeśli twoja grupa ma bardziej nieformalny styl online, wyjaśnij użytkownikom, jak osiągnąć ton podczas pisania kopii internetowej.

5.

Powiedz użytkownikom, jakie kolory mogą wykorzystać podczas projektowania stron. Wymień kolory dla każdego typu tekstu, obrysu zdjęcia, nagłówka, paska nawigacyjnego i separatora stron. Podaj szczegółowe kody kolorów RGB, aby zapewnić spójność. Wyjaśnij użytkownikom, że kolor jest skutecznym sposobem wyrażania wizerunku marki i ostrzegania go, aby korzystał tylko z podanych kolorów, aby zachować ogólne wrażenia użytkownika.

6.

Ułóż zasady korzystania z fotografii na stronach organizacji. Jeśli wszystkie strony mają określony projekt, wyjaśnij, gdzie użytkownicy mogą umieszczać zdjęcia. Wymień wymiary pikseli wymagane dla różnych zastosowań: na przykład zdjęcia w tekście, zdjęcia z nagłówka lub zdjęcia z paska bocznego. Aby strona była łatwiejsza do załadowania, podaj konkretne rozdzielczości - w sieci standardem jest 72 dpi. Poinformuj użytkowników o przycięciu, zmianie rozmiaru i edycji obrazów przed umieszczeniem ich na stronie internetowej w celu zoptymalizowania prędkości.

7.

Zamknij dokumentację, wyjaśniając wymagane oświadczenie lub elementy projektu, które muszą znajdować się na każdym typie strony. Uwzględnij elementy, takie jak oświadczenia o zatrudnieniu równych szans i informacje o prawach autorskich, i pozwól użytkownikom poznać dokładne miejsce docelowe na stronie. Jeśli masz grafikę lub obraz, który powinien pojawić się na stronie, podaj wymagania dotyczące miejsca docelowego i przekaż plik do natychmiastowego pobrania.