--=REKLAMA=--
Zapoznaj się z tym poradnikiem, jeśli chcesz pomagać w rozwijaniu i utrzymaniu pomocy ekranowej dla Joomla. Poradnik opisuje sekcje, jakie powinny się znaleźć w artykułach systemu pomocy nazywanych ekranami pomocy, oraz podpowiada, tworzyć zawartość systemu pomocy. Jeśli masz pomysły, sugestie, możesz poprawiać ten poradnik lub zgłosić je na stronie dyskusji.
Każdy ekran pownien rozpoczynać się od sekcji Streszczenie. Objaśnij w nim zwięźle cel - przeznaczenie ekranu. Streszczenie jest używane w zestawieniach pomocy na całym wiki.
Poniżej streszczenia, w sekcji Jak uzyskać dostęp wskaż lokalizację opisywanego ekranu zaplecza Joomla. Przedstaw kroki, jakie trzeba wykonać, aby dotrzeć do ekranu z różnych miejsc zaplecza.
Pamiętaj, że ekrany pomocy można pobrać na wiele różnych sposobów, nie tylko podczas wykonywania czynności administracyjnych na zapleczu. Na przykład ktoś korzystajacy z wyszukiwarki Google, aby dowiedzieć się, jak coś zrobić, trafi na ekran pomocy na wiki, a nie na zapleczu Joomla.
Pamiętaj również, że dostęp mogą chcieć uzyskać osoby z różnymi niepełnosprawnościami, które np. nie widzą albo nie używają myszki.
Oto przykłady:
Zrzut ekranu przedstawiający ogólny wygląd. Niekoniecznie musi przedstawiać całą zawartość
np. [[Plik:j35_artykuly-kategorie-dostosuj-kategorie.png|700px|Ekran edytora kategorii artykułów]]
Przedstaw:
Nie określamy formatu tej sekcji, ponieważ opis zależy od celu i przeznaczenia ekranu. Opis może zawierać podsekcje.
Ta sekcja powinna być umieszczana tylko w opisach ekranów, które przedstawiają menedżery, czyli ekrany służące do zarządzania wieloma pozycjami (np. artykułami, kategoriami, modułami, kontaktami).
Poinformuj zwięźle, co zawiera lista pozycji znajdująca się w obszarze roboczym. Zwróć uwagę na elementy nietypowe.
Zilustruj tę sekcję zdjęciem fragmentu listy, np. nagłówka i 2-3 wierszy.
Objaśnij znaczenie informacji w każdej kolumnie. W opisach wykorzystaj szablony powtarzalnych komunikatów:
Przedstaw tu informacje o dostępnych filtrach. Informacje umieść pod śródtytułami nazywającymi opisywany filtr. W opisach wykorzystaj szablony powtarzalnych komunikatów:
Jeśli w udostepnianych na stronie narzędziach jest funkcjonalność Przetwarzanie wsadowe, opisz jej możliwości. Zilustruj zrzutem ekranu.
Poinformuj, dokąd prowadzą łącza w nawigacji lokalnej. Nazwa strony docelowej powinna być łączem do opisującego ją ekranu pomocy. Na przykłąd:
Ta sekcja powinna być umieszczana tylko w opisach ekranów, które zawierają formularze służące do tworzenia i poprawiania zawartości oraz konfigurowania ustawień serwisu (np. Konfiguracja globalna) lub poszczególnych rozszerzeń (np. Opcje komponentu Reklamy)
Dla każdej karty utwórz odrębną sekcję. Zatytułuj ją etykietą (nagłówkiem) karty lub panelu, np. Karta Integracja, Karta Opcje publikacji. Każdą podsekcję rozpocznij od zrzutu ekranu, przedstawiajacego zawartość karty.
Objaśnij znaczenie każdego detalu lub opcji. W opisach wykorzystaj szablony powtarzalnych komunikatów:
Jeśli pola są pogrupowane w zestawy pól albo na kartach lub panelach rozwijanych, zgrupuj pola pod śródtytułami.
Oczywiście, ta sekcja powinna być umieszczana tylko w opisach ekranów, na których znajduje się przybornik (pasek narzędziowy).
Objaśnij znaczenie przycisków w przyborniku. Napisz prostym zdaniem, co przycisk robi. W opisach wykorzystaj szablony powtarzalnych komunikatów:
Możesz też posłużyć się szablonami zestawów przycisków:
Zobacz pełną listę i generowaną treść: Przyborniki
Jak wskazuje tytuł, ta sekcja powinna zawierać zwięzłe wskazówki, podpowiedzi, sugestie, które mogą pomóc użytkownikowi w wykonywaniu zadań związanych z ekranem. Użyj listy punktowanej.
Powinna to być lista odnośników do dalszych lub powiązanych informacji. Wszystkie łącza powinny być stronami na tej wiki. Nie umieszczaj żadnych łączy zewnętrznych bez ważnego powodu.
Na końcu utwórz łącze do ekranu pomocy w wersji angielskiej jako dokumentu źródłowego. Posłuż się szablonem: