Docs Italia beta

Documenti pubblici, digitali.

6. Gestione dei documenti

6.1. Visibilità del documento

Dopo aver pubblicato il documento su Docs Italia, è utile eseguire le seguenti operazioni per aumentarne la visibilità.

6.1.1. Presentazione sul proprio sito web

È opportuno inserire i link ai documenti nel proprio sito web, creando una sezione ad hoc, se necessario.

Docs Italia sta lavorando alla creazione di alcuni widget che permetteranno di pubblicare in modo semplice sul proprio sito la lista dei link ai propri documenti e, per ciascun testo, l’indice completo.

6.1.2. Pubblicazione sulla home page di Docs Italia

I documenti più recenti vengono visualizzati automaticamente nella home page di Docs Italia.

Aggiungere i metadati e indicare l’eventuale progetto di riferimento può aiutare gli utenti a trovare più facilmente il tuo documento.

6.1.3. Divulgazione su Forum Italia

È possibile dare visibilità ai nuovi documenti utilizzando Forum Italia, il forum di discussione sui progetti digitali della Pubblica Amministrazione. Per farlo, basta andare su Forum Italia e aprire un topic (è richiesta la registrazione) in corrispondenza del Progetto cui fa riferimento il documento.

La Figura 6.1 mostra l’annuncio su Forum Italia relativo alla pubblicazione del Codice dell’amministrazione digitale.

Forum Italia

Se il documento non è associato ad alcun Progetto, è possibile usare la categoria Community & Altro.

6.1.4. Promozione sui canali social

Un’ulteriore promozione del documento può avvenire attraverso i canali social. Twitter è un ottimo modo per condividere il link e aumentare il traffico verso il proprio sito.

Alcuni dei documenti verranno promossi sulla newsletter di Developers Italia. Anche in questo caso, è necessario contattare il Team per stabilire la strategia più appropriata.

6.2. Operazioni di manutenzione

Dopo la pubblicazione, sono necessarie alcune operazioni per mantenere i documenti aggiornati. Le modifiche possono essere necessarie a seguito di cambi nella legislazione, di segnalazioni degli utenti tramite issue su GitHub e Forum, o semplicemente per migliorare la documentazione stessa.

6.2.1. Modifiche alla documentazione

Qualsiasi modifica alla documentazione avviene modificando i file all’interno del repository GitHub. La procedura è descritta in appendice. Una modifica alla documentazione effettuata tramite un commit sul repository genererà automaticamente la documentazione aggiornata su Docs Italia.

È buona pratica rivedere il contenuto dei testi con scadenza periodica, in modo da evitare che le informazioni diventino obsolete o addirittura errate.

Le modifiche sostanziali alla documentazione, a seguito per esempio di un cambiamento nella legislazione o nel software di riferimento, devono essere associate a una versione differente (vedi l’appendice sul versionamento).

6.2.2. Issues e pull requests

Lo sviluppo collaborativo della documentazione tramite GitHub si avvale di due funzionalità: issues e pull requests.

Le issues (letteralmente “problemi”) servono a indicare ai responsabili del progetto dei possibili problemi con la documentazione, dai semplici refusi nel testo agli errori fattuali nei contenuti.

Le pull requests servono invece per proporre direttamente delle modifiche che, dopo una revisione da parte del publisher, possono essere integrate direttamente nel progetto.

Questi strumenti permettono agli utenti di segnalare eventuali errori e possibili correzioni, garantendo quindi un alto standard di qualità per la documentazione.