pisanie samouczka¶

tekst używany do tej pory w pierwszej sekcji tutoriali TYPO3:

„ten dokument jest samouczkiem. Samouczki mają być instrukcjami krok po kroku, specjalnie stworzonymi, aby przejść początkującego przez określone zadanie od początku do końca. Aby ułatwić skuteczną naukę, tutoriale dostarczają przykładów ilustrujących tematy, które obejmują. Ponadto samouczki zawierają wskazówki dotyczące unikania wspólnych pułapek i podkreślają kluczowe pojęcia, które należy zapamiętać w przyszłości.”

patrząc na literaturę wymienioną poniżej powinniśmy rozważyć następujące kluczowe punkty:

• samouczek to lekcja, zorientowana na naukę, pokazująca kroki, aby coś ukończyć, dzięki czemu czytelnik powinien osiągnąć coś znaczącego i doświadczyć sukcesu, znaleźć to wykonalne i przyjemne, zwiększyć kompetencje, zdobyć pewność siebie i chce to zrobić ponownie.
• skoncentruj się na wiedzy praktycznej, a nie na wiedzy teoretycznej. Naucz się nowego rzemiosła lub umiejętności, skoncentruj się na nauce wykonując

:

• pozwól użytkownikowi uczyć się przez działanie,
• przejdź od prostego do złożonego
• rozpocznij pracę użytkownika
• możesz pokazać kroki, które początkujący rozumie najlepiej. „najlepsza praktyka” może być czymś innym. To, jak zrobiłby to doświadczony użytkownik, może być czymś innym.
• celem jest rozruch czytelnika, a nie doprowadzenie go do miejsca docelowego.
• upewnij się, że Twój samouczek działa!
• inspiruj pewność siebie początkującego: w oprogramowaniu, w samouczku, w tutorialu i, oczywiście, w ich własnej zdolności do osiągnięcia tego, o co się od nich prosi.
• upewnij się, że użytkownik natychmiast widzi wyniki
• zakończenie każdej sekcji samouczka lub samouczka jako całości musi być znaczącym osiągnięciem.
• Twój samouczek musi być niezawodnie powtarzalny.
• skup się na konkretnych krokach, a nie abstrakcyjnych pojęciach. Pokusa wprowadzenia abstrakcji jest ogromna: oprzyj się!
• podaj niezbędne minimum
• skup się tylko na krokach, które użytkownik musi wykonać