Wytyczne dotyczące tworzenia ściągawek
Ściągawki proste i złożone umożliwiają użytkownikom osiąganie zakładanych celów poprzez wykonanie sekwencji czynności. W niniejszych wytycznych opisano, kiedy należy stosować ściągawki i w jaki sposób należy je tworzyć.
Kiedy należy tworzyć ściągawki
Ściągawki doskonale sprawdzają się w przypadku czynności, w ramach których wykonywane są etapy prowadzące do wymiernego celu, jakim może być na przykład zbudowanie prostej aplikacji. Cel ten musi być jednoznacznie określony, aby użytkownik mógł zobaczyć pomyślne rezultaty po wykonaniu wszystkich etapów opisanych w ściągawce. Ściągawki nadają się do tworzenia kursów, w których celem jest nauka wykonywania określonej czynności. Ściągawka zawiera zazwyczaj maksymalnie 10 etapów, które można wykonać w ciągu nie dłużej niż pół godziny. W przypadku bardziej rozbudowanych czynności należy rozważyć zastosowanie ściągawki złożonej.
Kiedy należy tworzyć ściągawki złożone
Ściągawki złożone mają na celu ułatwienie wykonywania czynności, których ze względu na zakres nie można opisać w ramach pojedynczej prostej ściągawki, lub które spełniają kilka celów. Za pomocą ściągawki złożonej można opisać sekwencję czynności, z których każda wynika z poprzedniej.
Kiedy nie należy stosować ściągawek
Ściągawki sprawdzają się najlepiej w sytuacjach, w których problem można rozwiązać, wykonując sekwencję prostych czynności. Nie zastępują one systemu pomocy, który umożliwia tworzenie stron HTML z rozbudowanymi elementami graficznym oraz funkcjami wyszukiwania i hiperłączami zapewniającymi swobodny dostęp do informacji. Ściągawki nie są przeznaczone do stosowania w przypadku czynności wymagających od użytkownika wpisania dużej ilości tekstu.
Wytyczne dotyczące tworzenia ściągawek
- Należy wybrać krótki, znaczący tytuł.
- W ściągawkach należy (w miarę możliwości) stosować odsyłacze do systemu pomocy, które pozwalają uzyskać dodatkowe bądź bardziej szczegółowe informacje.
- Jeśli w ściągawce ma występować więcej niż 10 etapów, należy wziąć pod uwagę zastosowanie ściągawki złożonej.
- W miarę możliwości należy wykorzystywać komendy do wykonywania żmudnych czynności, takich jak otwieranie perspektyw lub zasobów bądź uruchamianie kreatorów. Ponadto należy wyjaśnić, w jaki sposób można uzyskać te same rezultaty bez stosowania komendy.
- Należy zapewnić możliwość pominięcia komend, jeśli użytkownik zechce wykonać czynności ręcznie.
- Należy ustawić parametr dialog="true" w przypadku etapów wymagających otwarcia okna dialogowego. Spowoduje to otwarcie ściągawki w pasku zadań większości okien dialogowych.
- Etapy należy zorganizować w taki sposób, aby użytkownik często widział pomyślne rezultaty wykonywanych operacji. Ściągawkę, w której dokonywanych jest wiele zmian w kodzie źródłowym w języku Java oraz uruchamiana jest aplikacja należy zmodyfikować tak, aby aplikacja była uruchamiana po każdej zmianie w kodzie źródłowym.
- Należy dopilnować, aby użytkownik zdawał sobie sprawę z celu wykonywania każdej czynności.
- Zamiast opisywać kilka sposobów wykonania czynności należy wybrać najprostszy sposób, który wymaga najmniej rozbudowanego opisu.
- Aby zwiększyć czytelność tekstu, należy stosować znaczniki nowego wiersza (<br/>).
- Do dzielenia czynności na mniejsze etapy można stosować podpunkty.
- Nie wszystkie ściągawki wymagają stosowania podpunktów.
- Tekst etykiety podpunktu należy rozpoczynać słowami takimi jak "wpisz", "rozwiń", "wybierz" itp.
- W przypadku etykiet podpunktów należy jednoznacznie określić elementy interfejsu za pomocą cudzysłowów. Dzięki temu użytkownicy będą mogli odróżnić tekst instrukcji od elementów interfejsu, które muszą rozpoznać w celu skorzystania z nich.
- Każdy podpunkt powinien dotyczyć jednej, niepodzielnej czynności, na przykład wpisywania jednej wartości.
- W ostatnim etapie czynności opisanej w ściągawce należy zawsze umieszczać element <onCompletion>.
- Należy przetestować kilka wersji ściągawek o różnych rozmiarach widoku ściagawki.
- Podczas testowania ściągawek powinien być otwarty widok dziennika błędów. Pozwala to zaobserwować, czy w dzienniku zostały zapisane jakiekolwiek ostrzeżenia.
Wytyczne dotyczące tworzenia ściągawek złożonych
- Ściągawka złożona powinna zawierać czynności, które łączy wspólny temat.
- Każde zadanie umieszczone w ściągawce złożonej powinno mieć ściśle zdefiniowany cel.
- Powodzenie operacji należy potwierdzać za pomocą elementów <onCompletion>.
- Nazwy czynności powinny być krótkie i zwięzłe.
- Złożone problemy można rozwiązywać za pomocą czynności, w których wykorzystuje się rezultaty wcześniej wykonanych operacji.
- W przypadku czynności opcjonalnych należy korzystać z elementu skip="true".
- Aby zapewnić spójność, wprowadzenie i nazwa ściągawki prostej powinny pokrywać się z wprowadzeniem i nazwą określonymi w ściągawce złożonej.
- W opisach czynności należy jednoznacznie wyróżniać pogrubioną czcionką tekst interfejsu.
- Z sekwencji należy korzystać jedynie w sytuacji, gdy konieczne jest wymuszenie określonej kolejności wykonywania czynności.
Odsyłacze do stron pokrewnych
Praca ze ściągawkami
Praca ze ściągawkami złożonymi
Ściągawki proste
Ściągawki złożone