User Documentation Struttura
Le attuali cinque guide pratiche sono state pubblicate per la prima volta come articoli nel Joomla Community Magazine, scritte da Brian Teeman e da lui inviate per questa documentazione.
Stiamo ancora lavorando sulle strutture del menu per posizionare guide pratiche, tutorial, spiegazioni ecc. in modo tale da poterli filtrare e ordinare dinamicamente. Per ora pubblicheremo semplicemente queste guide pratiche in ordine casuale.
Informazioni sulle guide pratiche
Da https://diataxis.fr/how-to-guides/:
Le guide pratiche sono indicazioni che guidano il lettore attraverso un problema o verso un risultato. Le guide pratiche sono orientate agli obiettivi.
Una guida pratica aiuta l'utente a portare a termine qualcosa, correttamente e in sicurezza; guida l'Azione dell'utente.
Riguarda il lavoro - navigare da un lato all'altro di un problema del mondo reale.
Alcuni esempi potrebbero essere: come calibrare l'array radar; come usare le fixture in pytest; come configurare le politiche di back-off per la riconnessione. D'altra parte, come creare un'applicazione web non lo è - non affronta un obiettivo o un problema specifico, è una sfera di competenze vastamente aperta.
Le guide pratiche sono importanti non solo perché gli utenti devono essere in grado di portare a termine le cose: l'elenco delle guide pratiche nella tua documentazione aiuta a delineare un quadro di ciò che il tuo prodotto può effettivamente fare. Un elenco ricco di guide pratiche è un suggerimento incoraggiante delle capacità di un prodotto.