In breve: Mettere online la documentazione significa renderla raggiungibile a chiunque tramite un indirizzo web. Servono file ordinati, un servizio di hosting e qualche controllo finale.
Cosa vuol dire pubblicare la documentazione
La documentazione è l'insieme dei testi che spiegano un progetto. Può contenere guide, istruzioni e immagini.
Pubblicarla su un sito web vuol dire caricarla online. Da quel momento, chiunque abbia il link può leggerla dal browser.
Questo è utile per condividere il lavoro con clienti, colleghi o docenti. Sostituisce la consegna di file via email o chiavetta.
Come si pubblica passo dopo passo
Prima si preparano i file in una cartella locale. Spesso il file principale si chiama index.html oppure README.md.
Poi si sceglie un servizio di hosting, cioè un computer sempre acceso che ospita il sito. Alcuni servizi sono gratuiti per progetti scolastici.
Si caricano i file tramite l'interfaccia del servizio o con strumenti come Git. Al termine, il servizio fornisce un indirizzo pubblico (URL).
Infine si controlla che il sito si apra correttamente. Vanno verificati i link, le immagini e la leggibilità da telefono.
Esempi pratici
Un esempio comune è GitHub Pages. Si crea un repository, si inseriscono i file e si attiva la pubblicazione dalle impostazioni.
Un altro caso: una scuola pubblica il manuale di un progetto. Gli studenti caricano la cartella sul servizio scelto e condividono il link.
Un terzo esempio è la documentazione di un'app. Lo sviluppatore aggiorna i testi, ricarica i file e il sito mostra subito la versione nuova.
Parole difficili
- Documentazione: insieme di testi che spiegano come funziona un progetto o un programma.
- Hosting: servizio che ospita i file di un sito su un computer collegato a internet.
- URL: indirizzo che identifica una pagina web (esempio: www.esempio.it).
- Repository: cartella online dove si conservano i file di un progetto.
- Browser: programma usato per aprire pagine web, come Chrome o Firefox.
- Link: collegamento cliccabile che porta a un'altra pagina o risorsa.
Riferimenti
- Norma: Norme generali e livelli essenziali delle prestazioni relativi al secondo ciclo del sistema educativo di istruzione e formazione
- Obiettivo formativo coperto: ob.iefp-tecnico-informatico.competenze-tecnico-professionali.cl3.prodotti-comunicazione.06