istruzioni per l’uso: come creare manuali e guide di prodotti con confluence

Nelle aziende di produzione è normale dover creare manuali e guide sull’utilizzo dei prodotti in cui vengono mostrate fotografie, grafici, tabelle di dettaglio e tutte queste informazioni vengono redatte da diverse persone che probabilmente non sanno esattamente cosa è già stato scritto e come.

Credo sia capitato a tutti di trovare molte inesattezze, errori o duplicazioni leggendo qualsiasi libretto di istruzioni.

Ci sono in effetti software dedicati allo sviluppo di manuali e guide, ma fanno solo quello.

La soluzioni invece adottabile con Confluence è quella di avere la possibilità di costruire questi documenti in modo semplice, condiviso tra le persone necessarie e con criteri di flussi di approvazione e pubblicazione del documento stesso.

cosa serve e come iniziare

Sicuramente serve Confluence e in questo caso occorre una versione “server” cioè un’installazione “on-premise”.
Niente paura, questo non significa che devi comprare server, storage, installare e configurare… possiamo comunque utilizzare l’intera piattaforma in altro cloud con le tue licenze.

Il perché dell’installazione on-premise è legato all’utilizzo di alcuni plugin che nella versione cloud non sono presenti.

I plugin utilizzati in questa soluzione, li vedremo all’interno di questo articolo.

creazione ambiente di lavoro

Come sappiamo Confluence è organizzato in “ambienti” denominati space. Lo space è di per sé una pagina di Confluence, che può però a sua volta contenere altre pagine.

Evidentemente il come organizzare in space le informazioni è argomento da verificare situazione per situazione, ma di fatto potremmo in questo caso ipotizzare, uno prodotto da documentare, uno space in cui scrivere.

Altra cosa interessante è legata ai sistemi di autorizzazione e di accesso alle informazioni, perché Confluence permette un’amministrazione generale, ma anche una più granulare proprio sugli space, per cui potrei avere un amministratore di uno o più space che però non è amministratore di confluence.

processi di approvazione di pubblicazione

Un vero e proprio sistema di approvazione documentale non esiste in confluence, per cui è necessario utilizzare un prodotto esterno, in questo caso il plugin è Comala Workflows che permette la creazione di processi di approvazione, anche molto complessi, delle pagine e della loro pubblicazione.

Il concetto di base lo potremmo esemplificare in:

bozza – revisione – approvazione – pubblicazione

Il plugin permette anche la creazione di task (attività) e di notifiche in modo che il team o le persone autorizzate siano informate sulle cose da fare o su ciò che è stato modificato.

E’ possibile con questo plugin creare workflow molto complessi per esigenze particolari, ma il mio consiglio è quello di partire con un semplice processo di revisione – approvazione – pubblicazione.

caricare immagini, creare tabelle, formattare i documenti

confluence utilizza un editor molto evoluto, che permette una estesa formattazione del documento, così come il caricamento delle immagini o la creazione di tabelle.

Nota sulle tabelle: l’uscita della versione 5.10 di Confluence prevede, finalmente perché era una discreta mancanza, la gestione delle tabelle in modalità “responsive”, semplicemente significa che posso dimensionarle o lasciarle in modalità fissa.

Confluence permette in modo nativo di caricare le immagini e di gestire in modo semplice all’interno del documento.

Posso quindi dire che il problema della formattazione e dei contenuti, non esiste.

collaborare sul documento

La collaborazione delle persone sui documenti è la vera forza di Confluence, con la possibilità di citare qualcuno (@mention), gestire le discussioni, verificare le versioni dei documenti e degli allegati… tutto questo gestito con il sistema di approvazione, permette la creazione di documenti ben scritti e revisionati.

la pubblicazione

Per gli utenti di Confluence, una volta pubblicati i documenti, questi diventano visibili per chi ne è autorizzato (ricordo che nel sistema di autorizzazione dei privilegi se non sei autorizzato ad un documento, non sai nemmeno se esiste!!) e sul sistema tutto finisce qui.

Ma chi deve pubblicare manuali e guide ha altri due problemi, la creazione di documenti in formato pdf / word da gestire per la stampa cartacea oppure la creazione di ebook per la pubblicazione digitale.

Confluence prevede una sua esportazione per esempio in formato pdf, ma direi che la si può utilizzare solo per scopi di bozza, avendo pochissime possibilità di configurazione.

esportare in formato word

Il plugin migliore è sicuramente Scroll Office della K15t che permette un’esportazione molto evoluta dei documenti in formato word a partire da modelli di word che possiamo crearci.

Questo consente di poter creare la nostra grafica, il nostro modo di esporre all’esterno i documenti, in modo coerente con la nostra “company identity”.

E’ possibile generare sommari, personalizzare tabelle, creare campi nascosti che prendono valori direttamente da campi di confluence, mostrare o meno in esportazione informazioni (che magari sono utili internamente ma non nella versione finale da pubblicare). Per esperienza personale posso dire d’aver creato documenti di offerta, template di progetto e molto altro che prendono la forma grafica desiderata in fase di esportazione.

esportare in formato pdf e in formato ePub

La stessa azienda K15t produce anche Scroll PDF Exporter e Scroll Epub Exporter che in modo molto similare, permettono una esportazione evoluta in formato pdf e in formato ePub dei nostri documenti.

riepilogando la soluzione

  1. utilizzo confluence perché è una piattaforma potente di gestione dei documenti con ampia configurabilità e gestione degli accessi e autorizzazioni
  2. utilizzo Comala Workflows per la gestione dei processi di approvazione e pubblicazione dei documenti
  3. utilizzo Scroll Office per l’esportazione dei documenti formato word altamente personalizzato con i miei modelli e template

esempio di costi per azienda da 25 utenti

LICENZA PRODOTTO NR. UTENTI COSTI ACQUISTO
Confluence 25 1.200,00$
Comala Workflow 25 480,00$
Scroll Office 25 300,00$
Costo totale di acquisto 25 1.980,00$

qualche nota in più

  • Il valore è espresso in USD per semplicità e corrispondenza con i listini pubblicati da Atlassian e sul loro marketplace.
  • Il costo di manutenzione e supporto per gli anni successivi è circa il 50% del valore della licenza (nel nostro caso circa 990,00$).
  • Il costo/utente mese che vengo a sostenere a regime è circa di 3,3$/mese per utente per una soluzione che evidentemente mi permette di fare molto altro (perché già compreso) e non solo manuali e guide come proposto in questo articolo.

costi di realizzazione

Una soluzione come quella proposta prevede complessivamente circa 8-10 giornate, compresa l’attivazione della piattaforma, la configurazione dei flussi e la formazione degli utenti, per un costo di circa 3.200/3.500 euro.

Spero tu abbia trovato utile questo articolo, in caso positivo, condividilo!

Mi occupo da sempre di tecnologie e soluzioni per migliorare i processi, flussi e informazioni nelle aziende, utilizzando le potenzialità della rete e dei sistemi di collaborazione. Tengo corsi di formazione e svolgo spesso attività di relatore a convegni e focus sulle tecnologie e sulle metodologie di condivisione e analisi delle informazioni e dati aziendali. Appassionato di sistemi di business intelligence, ho una predilezione per Excel. Aree di intervento: temporary management - progettazione sistemi di business intelligence - progetti di condivisione delle informazioni - formazione su sistemi Confluence / Jira - sviluppo e gestione di website professionali

Leave a reply:

Your email address will not be published.

Site Footer

Questo sito o gli strumenti terzi da questo utilizzati si avvalgono di cookie necessari al funzionamento ed utili alle finalità illustrate nella cookie policy. Accettando, acconsenti all’uso dei cookie. maggiori informazioni

Questo sito utilizza i cookie per fornire la migliore esperienza di navigazione possibile. Continuando a utilizzare questo sito senza modificare le impostazioni dei cookie o cliccando su "Accetta" permetti il loro utilizzo.

Chiudi

nella vita ho capito due tastiere: la chitarra prima, il computer poi.