--=REKLAMA=--

Pomoc

Jak napisać dobry poradnik

Z Joomla!WikiPL

Wersja Zwiastun (dyskusja | edycje) z dnia 13:40, 4 sty 2014

(różn.) ← poprzednia wersja | przejdź do aktualnej wersji (różn.) | następna wersja → (różn.)

Oto kilka prostych porad dla osób, które chcą napisać dobry poradnik:

Zacznij od małego
Twój poradnik nie musi być obszernym podręcznikiem, złożonym z wielu rozdziałów. Jeśli dopiero zaczynasz swoją przygodę z tworzeniem poradników, zacznij od prostych instrukcji przedstawiających, jak wykonać zadanie administracyjne, uzyskać jakiś ciekawy efekt na stronie, posłużyć się modułem czy dodatkiem. Później możesz taki poradnik rozbudować, jeśli będzie to potrzebne.
Określ cel poradnika
We wstępie poradnika określ wyraźnie jego cel - co poradnik objaśnia, jaki problem pomaga rozwiązać, jakiej wersji Joomla! dotyczy
Wskaż, dla kogo poradnik może być pomocny
Pożądane jest również określenie, dla kogo poradnik jest przeznaczony. Jeśli zakładasz, że do wykonania zadań omówionych w poradniku wymagane są pewne kompetencje, wskaż je (np. że wymagana jest podstawowa znajomość CSS)
Przybliż problem, któremu poświęcony jest poradnik
Zanim przedstawisz proponowane lub zalecane działania, przybliż sytuację, która wymaga działania, np. opisz wymaganie, obowiązujący standard, scharakteryzuj potrzebę, z jakiej wynika podjęcie działania.
Przedstaw typowe procedury wykonywania zadań
W głównej części poradnika przedstaw w sposób uporządkowany, krok po kroku, sposób wykonywania zadania lub zadań. Przedstawiając kolejne kroki, ostrzegaj przed możliwością popełnienia błędów, pominięcia istotnych szczegółów.
Ilustruj procedury zdjęciami ekranów

Zadbaj o odpowiednie zilustrowanie poradnika. Na przykład umieść zdjęcia ekranów, jeśli tylko objaśniają sposób wykonania zadania albo pokazują efekt. Znane powiedzenie mówi, że czasem dobry obraz wart jest więcej niż 1000 słów. Ale pamiętaj też, że nawet 1000 źle dobranych obrazków nie jest warte więcej niż jeden dobry akapit tekstu.

Przedstaw znane problemy w stosowaniu opisanego rozwiązania
Jeśli proponowane rozwiązania mogą powodować problemy, przedstaw je i opisz, jak sobie z nimi radzić.
Ograniczaj dygresje
Skupiaj się na głównym temacie poradnika, nie poświęcaj zbytniej uwagi sprawom mniej ważnym, pobocznym, dodatkowym. Jeśli
Linkuj do innych artykułów

Zamiast poświęcać w poradniku miejsce na rzeczy już wystarczająco przedstawione w innych artykułach JoomlaWiki, umieść odsyłacze do tych artykułów. Na przykład zamiast przypominać jakąś typową procedurę, lepiej umieścić link do artykułu, w którym została przedstawiona. Zamiast objaśniania jakiegoś terminu, zamień go na link do definicji. Oczywiście, z linkowaniem nie należy przesadzać. Czytający powinien znaleźć w poradniku wszystkie informacje niezbędne do wykonania zadania.

Zobacz też