Jak poprawnie pisać poradniki

1 Konkrety

W pewnym momencie utarł się pewien schemat pisania poradników, schemat zły i niepraktyczny. Wielokrotnie artykuł zaczynał się od powtórzenia jego nazwy, tudzież tematu. Niezliczoną ilość razy w tekście pojawiały się luźne dygresje, krótsze lub dłuższe wstawki bez znaczenia dla wątku i niezliczona ilość innych, zbędnych elementów. 

Zatem, redagując poradnik staraj się, by zawierał on wyłącznie potrzebne i praktyczne informacje.

2 Formatowanie

Poradnik to nic innego jak zbiór wskazówek gdzie granice stanowią kategorie. Wskazówki mają to do siebie, że ich celem jest... wskazywanie. Będąc w obcym kraju, nie znając języka chciałbyś/aś pewnie, by odpowiedź była nie tylko w języku, który znasz, ale możliwe konkretna, prawda?

Unikaj stosowania dodatkowych kolorów, różnych czcionek i ich rozmiarów. Zadbaj, by odstępy między poszczególnymi blokami typu kod, lista były w sam raz, nie za duże i nie za małe. 
Ważne informacje zaznaczaj stosując do tego pogrubienie lub odpowiednie tagi - o których poniżej.

3 Formatowanie - kroki

Bardzo istotnym elementem poradnika jest odpowiedni podział na kroki. Dłuższe poradniki są często wykonywane etapowo, a podział na kroki ułatwia późniejsze odnalezienie się w treści lub choćby analizę po spisie treści w wypadku gdyby efekt końcowy wyszedł inny od zamierzonego. 

W tym celu powstał specjalny tag step:

[step=1]Krok pierwszy[/step]

Tag ten ma nadany odgórnie wygląd, zatem darujmy sobie jego "upiększenia". Wewnątrz tagu nie stosujemy żadnych dodatkowych formatowań, w tym pogrubień!

Kroki numerujemy według kolejności występowania - bazując na przykładzie jest to krok pierwszy we względu na cyfrę podaną wewnątrz tagu

Nazwa kroku powinna być krótkim podsumowaniem czynności jakie w nim wykonamy, przykładowo:

• Pobranie i zaktualizowanie pluginów
  
• Dodanie stylów .css
  
• Edycja szablonu index_boardstats
  

4 Formatowanie - ważne informacje

Informacje ważne, krytyczne dla dalszego przebiegu poradnika powinny być odpowiednio zaznaczone. W tym celu możemy użyć tagu warn, który automatycznie wyróżni odpowiedni tekst. 

[warn]Tutaj treść[/warn]

Warto pamiętać, aby wewnątrz tego tagu nie przesadzać z pozostałymi tagami. Przykładowo, nie stosujemy pogrubienia na całość tekstu, a ewentualnie na kluczowe słowa.

5 Formatowanie - dodatkowe informacje

Dodatkowe, opcjonalne informacje lub objaśnienia zamykamy wewnątrz tagu info. Może to być zarówno dłuższy tekst jak i krótszy, ważne by odpowiednio go (tag) zastosować i nie doprowadzić do nadużycia. 

Zasada stosowania jest identyczna jak w przypadku [warn].

 

6 Formatowanie - kod

Forum oferuje różne rodzaje formatowania kodu w zależności od jego typu. Miej to na uwadze. 

• Znaczników [code] używaj tylko dla kodu ogólnego, tam gdzie nie chcesz by wkradły się zbędne tagi i formatowania. 
  
• Znaczników [php] lub [kod=php] używaj tylko do kodu PHP.
  
• Znaczniki [kod=css] stosuj do kodu CSS
  
• Znacznik [kod=html] stosuj w pozostałych przypadkach, gdzie w grę wchodzi struktura html.
  

7 Załączniki

Wszelkie załączniki, chociażby te przedstawiające efekt końcowy dodawaj do wątku w formie załącznika MyBB - wrzuconego na nasz serwer podczas tworzenia/edycji tematu. 

Poradniki z obrazami z zewnętrznych hostingów nie będą akceptowane bez względu na ich wartość merytoryczną. Nie może dochodzić do sytuacji, że ważne informacje przedstawiane są na zrzutach z ekranu, a te po czasie znikają.

8 Merytoryka

Każdy poradnik powinien mieć odpowiednią wartość merytoryczną. Opisuj omawiane zagadnienie dokładnie i na spokojnie, poradnik to nie forma na "kolano". Poradnik powinien wprowadzać nową wartość na forum lub sumować zebrane informacje z innych wątków - np z działu pomocy. Wątki typu Jak zmienić belkę nie będą akceptowane - jest to informacja dosłownie na jedną linię tekstu, poruszana niezliczoną ilość razy i niejednokrotnie lepiej opisana w działach pomocy i łatwo dostępna wyszukiwarką. 

9 Kategorie

Ostatnie, ale nie mniej ważne. Dla ułatwienia przeszukiwania zbioru wątków w tym dziale wprowadzone zostały kategorie poradnika, po których później można sortować dział. 

• Edycja szablonów / wygląd - ogólne wątki tyczące się stricte zmiany w wyglądzie forum.
  
• Nowe funkcje - wątki objaśniające proces wdrożenia na forum nowej funkcji, możliwości, niedostępnej uprzednio w silniku
  
• Pluginy - cokolwiek tyczące się wtyczek. Ich edycja, konfiguracja, zastosowanie, instalacja i aktywacja. 
  
• Serwer - sprawy ogólne dotyczące tego co pod maską. Wszelkie wątki dotyczące zmian na plikach, grzebania w bazie danych, przygotowywanie środowiska serwerowego i inne.
  
• Inne - wątki, które nie znalazły dopasowania w innych kategoriach. Zazwyczaj dotyczą one samego silnika MyBB, pełniąc funkcję objaśniającą.