psaní tutoriálu¶

Text použitý dosud v první části TYPO3 tutoriálů:

„tento dokument je výukový program. Návody jsou navrženy tak, aby byly krok za krokemspecificky vytvořeny tak, aby procházely začátečníka konkrétním úkolem od začátku do konce. Pro usnadnění efektivního učení poskytují výukové programy příklady, které ilustrují předměty, které pokrývají. Výukové programy navíc poskytují pokyny, jak se vyhnoutspolečné nástrahy a zdůrazňují klíčové pojmy, které by měly být zapamatovány pro budoucí použití.“

z pohledu níže uvedené literatury bychom měli zvážit následující klíčové body:

• výukový program je lekce, orientovaná na učení, ukazující kroky k dokončení něčeho, díky čemuž je čtenář informovanější
• čtenář by měl dosáhnout něčeho smysluplného a zažít úspěch, najít to proveditelné a příjemné, zvýšit kompetence, získat důvěru a chce to udělat znovu.
• soustřeďte se na praktické znalosti, nikoli na teoretické znalosti. Naučte se nové řemeslo nebo dovednost, soustředit se na učení tím, že dělá

pokyny:

• umožnit uživateli učit se tím, že dělá,
• přejít od jednoduchých až po složité
• Get uživatel začal
• je to v pořádku ukázat kroky začátečník chápe nejlépe. „nejlepší praxe“ může být něco jiného. Jak by to zkušený uživatel udělal, může být něco jiného.
• cílem je, aby čtenář začal, ne aby je dostal do konečného cíle.
• ujistěte se, že váš tutoriál funguje!
• inspirujte důvěru začátečníka: v softwaru, v tutoriálu, v lektorovi a samozřejmě ve své vlastní schopnosti dosáhnout toho, co se od nich žádá.
• ujistěte se, že uživatel vidí výsledky okamžitě
• závěr každé části tutoriálu nebo tutoriálu jako celku musí být smysluplným úspěchem.
• váš tutoriál musí být spolehlivě opakovatelný.
• zaměřte se na konkrétní kroky, nikoli na abstraktní pojmy. Pokušení zavést abstrakci je obrovské: odolat!
• uveďte minimální potřebné vysvětlení
• zaměřte se pouze na kroky, které uživatel potřebuje