Zasady tworzenie poradników dla dhosting.pl

Poradniki twórz na swoim dysku Google. Dzięki temu nasza współpraca nad jego ewentualnym dopracowaniem będzie dużo łatwiejsza. Wykorzystuj również dostępne metody edycji tekstu w taki sposób, żeby jego przeniesienie do WordPressa dla pracownika dhosting.pl było jak najbardziej intuicyjne – o tym w komentarzach do poszczególnych elementów. Przykłady, które mogłyby stanowić część poradnika, mają zwiększone wcięcie od lewej.

Poradnik powinien zaczynać się od wstępu, w którym zostaną zaprezentowane najważniejsze zagadnienia poruszane w poradniku. Może być nieco dłuższy od tradycyjnego leadu wykorzystywanego w artykułach prasowych. 

W idealnym scenariuszu powinien zawierać pozytywne skutki, które przyniesie wdrożenie instrukcji w życie, np.:

Wdrażając zmiany opisane w tym poradniku twoja strona będzie wczytywała się szybciej o około 15-20% niż do tej pory.

Wstęp jest jednym z najważniejszych elementów poradnika. Często to on decyduje o tym, czy tekst zostanie przeczytany przez odbiorcę.

Czego potrzebujesz

Jeżeli do pozytywnego ukończenia poradnika wymagane jest konkretnie oprogramowanie, napisz o tym w tym rozdziale, np.:

Jeśli chcesz w pełni ukończyć poniższy poradnik, twoja strona musi działać w oparciu o CMS WordPress. Ponadto będziesz potrzebował kilku wtyczek, które są dostępne za darmo:

  • Yoast SEO,
  • wtyczka nr 2,
  • wtyczka nr 3.

Instrukcja – krótkie kroki

Jeśli tematy, które poruszasz w poradniku nie wymagają szczegółowego omówienia, wykorzystaj listę numerowaną, np.:

  1. Przejdź do ustawień wtyczki „Wtyczka 1”.
  2. W polu „Zawartość pola” zmień wartość na „Nowa wartość”.

Instrukcja – długie kroki

Jeśli tematy poruszane w poradniku wymagają szczegółowego omówienia, każdy punkt traktuj jak jeden krok i oznaczaj go stylem „Nagłówek 2”, np.:

Krok 1 – Przejdź do ustawień wtyczki „Wtyczka 1”

„Wtyczka 1” odpowiada za sposób wyświetlania wpisów. Dzięki niej osiągniesz X. W ustawieniach musisz zmienić kilka rzeczy:

  • W polu „Zawartość pola 1” zmień wartość na „Nowa wartość 1”.
  • W polu „Zawartość pola 2” zmień wartość na „Nowa wartość 2”.
  • W polu „Zawartość pola 3” zmień wartość na „Nowa wartość 3”.

Krok 2 – Przejdź do ustawień wtyczki „Wtyczka 2”

Elementy interfejsów i treści na przyciskach

Elementy interfejsów oraz treści na przyciskach zapisujemy w następującej formie:

„Załóż konto”

Polskie cudzysłowy oraz pogrubienie. Buttony nazywamy „przyciskiem”. Praktyczne zastosowanie: W następnym kroku kliknij przycisk „Zainstaluj”. (oczywiście bez użycia kursywy)

Nazwy CMSów, wtyczek zapisujemy bez formatowania, np. WordPress, Joomla.

Obrazy

Obrazki czy zrzuty ekranu zamieszczaj w Google Docs przy pomocy „Wstaw obraz”.

Jeśli wymagana jest etykieta. Zrób to w takiej formie.

Wszystkie zrzuty ekranu dołączone do poradnika muszą być wykonane przez jego autora. Zdjęcia pobrane z zewnętrznych źródeł muszą być możliwe do wykorzystania od strony prawnej. Jeśli wymagane jest oznaczenia autorstwa – koniecznie napisz o tym w komentarzu do zdjęcia. Preferujemy zdjęcia wykonane przez autora poradnika lub takie, które nie wymagają oznaczenia autorstwa.

Jeśli istnieje uzasadnienie ich użycia, w poradniku mogą znaleźć się również GIFy oraz filmy.

Oznaczanie kodu

Kod wykorzystany w poradniku oznaczaj poprzez dodanie wcięcia po lewej stronie oraz kursywy, np.:

<p>Hello World!</p>

Zwracanie się do czytelnika

Do czytelnika zwracaj się w drugiej osobie liczby pojedynczej. Szczególnie ważne jest to w instrukcji.

ŹLE: Teraz należy kliknąć przycisk „Dalej”.

DOBRZE: Kliknij przycisk „Dalej”.

Zostaw odpowiedź

Please enter your comment!
Please enter your name here

Wspólna pomoc

Partnerzy dhosting.pl, Fundacja Mam Marzenie oraz twórcy ambitnych projektów – wspólnie z nami pomagają innym tworzyć „wielkie” projekty. Małe i duże. Tworzące różnicę.

To już ponad dwa miesiące współpracy z Fundacją Mam Marzenie

Od momentu ogłoszenia strategicznego partnerstwa pomiędzy dhosting.pl Sp. z o.o. a Fundacją Mam Marzenie minęły już ponad dwa miesiące. Od 5 listopada 2019 roku...

Program Partnerski 2.0 – dlaczego to robimy?

Marzeniem moim i wszystkich współtworzących dhosting.pl już od pierwszych dni powstania marki, było dostarczać rozwiązania, z których sami chętnie chcielibyśmy korzystać, a to wszystko...

Nowy Program Partnerski w dhosting.pl

Po wielu miesiącach prac mamy przyjemność zaprezentować nowy Program Partnerski dhosting.pl. Od dzisiaj to partnerzy decydują na co przeznaczą swoją prowizję, która będzie wzrastać...

Wywiad z Magdaleną Kilan – Fundacja Mam Marzenie

Fundacja Mam Marzenie istnieje na rynku już 16 lat i zrealizowała już prawie 8500 marzeń ciężko chorych dzieci. Organizacja opiera się o ludzi z...

Wsparcie ambitnych projektów

Tworząc w 2016 roku Elastyczny Web Hosting, chcieliśmy udostępnić ludziom usługę, która pozwoli im rozwijać swoje projekty bez zmartwień o infrastrukturę serwerową oraz koszty....
Zdecyduj, który projekt otrzyma wsparcie w ramach Programu Partnerskiego dhosting.pl lub dodaj własny.

Nasze social media

3,056FaniLubię
124ObserwującyObserwuj
160ObserwującyObserwuj
74SubskrybującySubskrybuj

Ostatnie komentarze

Kontakt z nami

dhosting.pl Sp. z o.o.
Al. Jerozolimskie 98
00-807 Warszawa

Infolinia: +48 22 292 01 01
Handlowy: +48 22 292 01 23
E-mail: bok@dhosting.pl

Podobne artykuły